Introduction
Welcome to the EasyDCIM APIv3 documentation.
This guide provides all the details you need to integrate with the EasyDCIM platform programmatically.
You’ll find descriptions of available endpoints, authentication methods, request and response examples, and usage notes.
The API is fully RESTful and returns responses in JSON format.
Use it to automate client management, device provisioning, and other system tasks efficiently.
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
Impersonation: If you are an admin with the impersonate-users ability, you can impersonate another user by sending their ID or email address in the X-Impersonate-User header.
The system will automatically detect whether the provided value is a numeric ID or an email address and impersonate the corresponding user.
API Tokens: You can generate and manage your API tokens directly in the EasyDCIM control panel. For detailed instructions, please visit the API Tokens documentation.
Admin Endpoints
System
Get Client Area Configuration
Returns current Client Area connection settings.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/client-area/config" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/client-area/config'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/client-area/config';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"mode": "local",
"is_enabled": true,
"full_url": "https://your-easydcim.com/client",
"company_name": "EasyDCIM",
"branding": {
"colors_primary": {
"50": "#EBF5FF",
"100": "#E1EFFE",
"200": "#C3DDFD",
"300": "#A4CAFE",
"400": "#83B3F7",
"500": "#6BA5F5",
"600": "#5396F4",
"700": "#3A87F2",
"800": "#1A73EF",
"900": "#0E60D2"
},
"logo_url": "logo.png",
"favicon_url": "favicon.ico",
"custom_css": "",
"custom_js_header": "",
"custom_js_footer": ""
},
"visibility": {
"services_table": {
"column_type": true,
"column_ip": true,
"column_status": true,
"column_location": true,
"column_created_at": true
},
"my_account": {
"two_factor_auth": true
}
},
"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"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Client Area Configuration
requires authentication
Updates the Client Area connection and branding settings.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/client-area/config" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
}
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/client-area/config'
payload = {
"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
}
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/client-area/config';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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,
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get System Configuration
requires authentication
Returns current system configuration for admin area.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/system/config" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/system/config'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/system/config';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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": "[email protected]"
},
"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"
}
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Health Check
requires authentication
Performs a full system health check, verifying core components: Redis, database, queue, web server (Apache), and remote agents.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/system/health-check" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/system/health-check'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/system/health-check';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Locations
List Locations
requires authentication
Returns a paginated list of locations
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/locations'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/locations';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 393,
"app_id": null,
"name": "Ondricka Inc",
"address": "46468 Mitchell Street\nNew Charlie, KS 82056-1964",
"city": "East Nella",
"state": "Washington",
"description": "Molestiae consectetur nostrum ab mollitia dolorum est natus. Qui libero accusamus fugit illum. Eligendi nihil provident eveniet minus est dolorem libero officia. Dolores et impedit cum expedita autem dicta ab.",
"notes": "Vel eius amet nam sit doloremque ut. Et rerum ut expedita. Temporibus quis dolorem velit adipisci nemo aut natus.",
"emergency": "1",
"phone": "1-650-313-9333",
"flag": "UK.png",
"created_at": "2026-04-21 13:15:58",
"updated_at": "2026-04-21 13:15:58"
},
{
"id": 394,
"app_id": null,
"name": "Bernier LLC",
"address": "51803 Brittany Spur Apt. 291\nNorth Pasqualefurt, TX 12968-6116",
"city": "Altenwerthbury",
"state": "Idaho",
"description": "Minima ea ducimus dignissimos facere doloribus corrupti. Mollitia dolorem sed facere libero nostrum. Quia enim perspiciatis aut molestiae. Quidem itaque quis modi.",
"notes": "Illo officiis eveniet voluptatem vel minima. Ea neque ut cupiditate et.",
"emergency": "0",
"phone": "(385) 774-1514",
"flag": "Germany.png",
"created_at": "2026-04-21 13:15:58",
"updated_at": "2026-04-21 13:15:58"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show location
requires authentication
Display detailed information about a single location by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/locations/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/locations/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/locations/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 395,
"app_id": null,
"name": "Bayer, Johns and Durgan",
"address": "35752 Von Land\nKarellemouth, NV 48917-2292",
"city": "Hilarioside",
"state": "Rhode Island",
"description": "Saepe consectetur pariatur dolorum dolores eligendi. Facilis odit nisi facilis ipsum. Beatae ut at qui repellendus.",
"notes": "Et assumenda voluptas minima iste ullam iusto ut. Et accusamus quisquam quidem ratione. Aperiam alias dolores natus.",
"emergency": "1",
"phone": "1-503-980-1647",
"flag": "UK.png",
"created_at": "2026-04-21 13:15:59",
"updated_at": "2026-04-21 13:15:59"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create location
requires authentication
Store a new location in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/locations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/locations'
payload = {
"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
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/locations';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 396,
"app_id": null,
"name": "Schmidt, O'Keefe and Schimmel",
"address": "965 Lemke Burg\nSouth Dan, KY 94459-2620",
"city": "North Berneice",
"state": "Delaware",
"description": "Vitae qui molestiae quo ut et. Perspiciatis qui numquam quaerat blanditiis id eos.",
"notes": "Culpa aliquid fugit beatae ipsam id omnis aperiam. Aut reiciendis culpa quo voluptate. Nostrum blanditiis aut hic est. In eos culpa minima sed saepe.",
"emergency": "0",
"phone": "408.839.1066",
"flag": "Germany.png",
"created_at": "2026-04-21 13:15:59",
"updated_at": "2026-04-21 13:15:59"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update location
requires authentication
Updates the specified location with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/locations/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Warsaw DC-1\",
\"address\": \"ul. Marszałkowska 10, Warsaw, PL\",
\"phone\": \"+48 22 123 45 67\",
\"description\": \"Primary colocation facility in Warsaw.\",
\"manager_id\": 12,
\"remote_agent\": 3
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/locations/5'
payload = {
"name": "Warsaw DC-1",
"address": "ul. Marszałkowska 10, Warsaw, PL",
"phone": "+48 22 123 45 67",
"description": "Primary colocation facility in Warsaw.",
"manager_id": 12,
"remote_agent": 3
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/locations/5';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Warsaw DC-1',
'address' => 'ul. Marszałkowska 10, Warsaw, PL',
'phone' => '+48 22 123 45 67',
'description' => 'Primary colocation facility in Warsaw.',
'manager_id' => 12,
'remote_agent' => 3,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 397,
"app_id": null,
"name": "Shanahan Group",
"address": "73966 Beier Lock Apt. 172\nPort Arvel, VT 47164-1783",
"city": "Jaskolskiland",
"state": "District of Columbia",
"description": "Eaque omnis aut magni quia ullam voluptatibus. Rerum quibusdam qui facere cupiditate. Voluptas est iste et ex est ab.",
"notes": "Necessitatibus cumque repellendus est odit. Recusandae hic praesentium ex nulla optio enim debitis. Nam quaerat vel amet est aut.",
"emergency": "0",
"phone": "1-406-860-3018",
"flag": "USA.png",
"created_at": "2026-04-21 13:16:00",
"updated_at": "2026-04-21 13:16:00"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete location
requires authentication
Removes the specified location from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/locations/7" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/locations/7'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/locations/7';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Racks
List Racks
requires authentication
Returns a paginated list of racks
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/racks'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/racks';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 155,
"name": "molestias",
"floor_id": 84,
"location_id": 398,
"description": "Sit consequatur beatae non nisi a tenetur impedit.",
"room": "nobis",
"units_number": 68,
"weight": 181,
"speed": 1000,
"manager_id": 680,
"location": {
"id": 398,
"app_id": null,
"name": "Romaguera, McKenzie and Schimmel",
"address": "29664 Lueilwitz Stream\nImaland, LA 01785",
"city": "Emardbury",
"state": "Kansas",
"description": "Non mollitia voluptatem sit voluptatibus quisquam error. Et accusamus reiciendis quasi qui dolorem sint at. Dolor sed eius in minus consequatur.",
"notes": "Beatae voluptates aut voluptates voluptatem vel. Hic dolor corrupti sit debitis laudantium. Omnis aspernatur esse sed quaerat quidem ipsam corporis. Nemo quas ipsa ea enim.",
"emergency": "1",
"phone": "+1-402-577-6343",
"flag": "Canada.png",
"created_at": "2026-04-21 13:16:00",
"updated_at": "2026-04-21 13:16:00"
},
"floor": {
"id": 84,
"name": "voluptatem",
"number": 34,
"rows": 8,
"columns": 6,
"racks": [
{
"id": 155,
"name": "molestias"
}
],
"created_at": "2026-04-21 13:16:01",
"updated_at": "2026-04-21 13:16:01"
},
"manager": {
"id": 680,
"username": "lesch.arnulfo",
"email": "[email protected]",
"name": "Otha Powlowski",
"firstname": "Otha",
"lastname": "Powlowski",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/75375cb63522c6ae54f76f7f53c58101?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/75375cb63522c6ae54f76f7f53c58101?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-04-21 13:16:01",
"updated_at": "2026-04-21 13:16:01"
},
{
"id": 156,
"name": "qui",
"floor_id": 85,
"location_id": 400,
"description": "Iste consequatur dolores nobis.",
"room": "quos",
"units_number": 16,
"weight": 140,
"speed": 100,
"manager_id": 683,
"location": {
"id": 400,
"app_id": null,
"name": "Mayert and Sons",
"address": "8138 Jamie Rapids\nSouth Wiley, MA 32766-5456",
"city": "South Robertofort",
"state": "Colorado",
"description": "Sed ratione unde eos. Sit nam sunt ipsam aspernatur. Hic saepe facilis et autem odit rerum tenetur. Deleniti autem atque adipisci aliquid.",
"notes": "Labore id velit quam similique et placeat. Mollitia quo consequatur illum fuga est neque. Sed laborum voluptatem et placeat libero soluta voluptatibus.",
"emergency": "0",
"phone": "863.505.6940",
"flag": "Germany.png",
"created_at": "2026-04-21 13:16:01",
"updated_at": "2026-04-21 13:16:01"
},
"floor": {
"id": 85,
"name": "eius",
"number": 8,
"rows": 6,
"columns": 9,
"racks": [
{
"id": 156,
"name": "qui"
}
],
"created_at": "2026-04-21 13:16:02",
"updated_at": "2026-04-21 13:16:02"
},
"manager": {
"id": 683,
"username": "keira.rice",
"email": "[email protected]",
"name": "Harrison Hagenes",
"firstname": "Harrison",
"lastname": "Hagenes",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/5ed7c8ba2da3ff9cf0de0b11d332634e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/5ed7c8ba2da3ff9cf0de0b11d332634e?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-04-21 13:16:02",
"updated_at": "2026-04-21 13:16: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show rack
requires authentication
Returns detailed information about a specific rack.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/racks/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/racks/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/racks/5';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 157,
"name": "modi",
"floor_id": 86,
"location_id": 402,
"description": "Blanditiis aut quibusdam molestiae quasi.",
"room": "repellendus",
"units_number": 27,
"weight": 58,
"speed": 100,
"manager_id": 686,
"location": {
"id": 402,
"app_id": null,
"name": "Yundt LLC",
"address": "115 Norval Rapid Apt. 678\nBradtkeview, MD 60333",
"city": "South Mattieberg",
"state": "New Mexico",
"description": "Quam est modi doloribus mollitia a neque delectus. Similique omnis inventore aut tempore.",
"notes": "Voluptas dolores explicabo tempora nisi consequatur dolorum. Ex eos dolorem voluptas qui est. Laboriosam repellat corrupti consequatur dignissimos velit.",
"emergency": "1",
"phone": "+1 (803) 961-6791",
"flag": "Canada.png",
"created_at": "2026-04-21 13:16:02",
"updated_at": "2026-04-21 13:16:02"
},
"floor": {
"id": 86,
"name": "quos",
"number": 18,
"rows": 4,
"columns": 9,
"racks": [
{
"id": 157,
"name": "modi"
}
],
"created_at": "2026-04-21 13:16:03",
"updated_at": "2026-04-21 13:16:03"
},
"manager": {
"id": 686,
"username": "hackett.florida",
"email": "[email protected]",
"name": "Branson Dibbert",
"firstname": "Branson",
"lastname": "Dibbert",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/64253c00738d480a037554e2b5a9660e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/64253c00738d480a037554e2b5a9660e?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-04-21 13:16:03",
"updated_at": "2026-04-21 13:16:03"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create rack
requires authentication
Creates a new rack within a specific location and floor.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/racks" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/racks'
payload = {
"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
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/racks';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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.0,
'manager_id' => 42,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 158,
"name": "rerum",
"floor_id": 87,
"location_id": 404,
"description": "Perferendis et nulla voluptatem expedita quibusdam sed quis.",
"room": "ipsum",
"units_number": 41,
"weight": 145,
"speed": 1000,
"manager_id": 689,
"location": {
"id": 404,
"app_id": null,
"name": "Quigley, Goldner and Mosciski",
"address": "66860 Lisa Loaf Suite 487\nNew Arelymouth, SC 74747-1706",
"city": "Andersontown",
"state": "Idaho",
"description": "Temporibus eum maxime inventore praesentium harum. Quaerat corporis rerum officia cumque aliquid rerum accusamus ut. Eligendi perspiciatis ipsa vel itaque laudantium amet.",
"notes": "Eveniet amet quia voluptas rerum. Aut tenetur vel esse voluptas totam. Inventore ut consequatur impedit sequi dignissimos nisi delectus qui. Qui dignissimos praesentium ratione maiores et velit sed.",
"emergency": "0",
"phone": "(770) 351-7086",
"flag": "Germany.png",
"created_at": "2026-04-21 13:16:03",
"updated_at": "2026-04-21 13:16:03"
},
"floor": {
"id": 87,
"name": "consectetur",
"number": 18,
"rows": 2,
"columns": 4,
"racks": [
{
"id": 158,
"name": "rerum"
}
],
"created_at": "2026-04-21 13:16:04",
"updated_at": "2026-04-21 13:16:04"
},
"manager": {
"id": 689,
"username": "isaac01",
"email": "[email protected]",
"name": "Ottis Gislason",
"firstname": "Ottis",
"lastname": "Gislason",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/570bf86e61498f22fe453edf1e81ff77?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/570bf86e61498f22fe453edf1e81ff77?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-04-21 13:16:04",
"updated_at": "2026-04-21 13:16:04"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update rack
requires authentication
Updates the attributes of an existing rack.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/racks/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/racks/5'
payload = {
"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
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/racks/5';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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.0,
'manager_id' => 42,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 159,
"name": "numquam",
"floor_id": 88,
"location_id": 406,
"description": "Provident ea illo cupiditate.",
"room": "veritatis",
"units_number": 16,
"weight": 128,
"speed": 1000,
"manager_id": 692,
"location": {
"id": 406,
"app_id": null,
"name": "Swift LLC",
"address": "208 Jacobs Club\nMarquisfort, NV 42341",
"city": "Port Tyrique",
"state": "Kansas",
"description": "Ea ea aut dignissimos molestiae corrupti assumenda distinctio id. Omnis et dignissimos labore officia earum eum. Vitae est quisquam ipsa voluptas reprehenderit nam atque. Velit est officia odio non sequi explicabo.",
"notes": "Et quis ipsa dolor consectetur et asperiores necessitatibus. Animi in consequatur non quos voluptates sit consequatur. Magnam error beatae nemo.",
"emergency": "0",
"phone": "+12679872455",
"flag": "USA.png",
"created_at": "2026-04-21 13:16:04",
"updated_at": "2026-04-21 13:16:04"
},
"floor": {
"id": 88,
"name": "error",
"number": 50,
"rows": 7,
"columns": 5,
"racks": [
{
"id": 159,
"name": "numquam"
}
],
"created_at": "2026-04-21 13:16:05",
"updated_at": "2026-04-21 13:16:05"
},
"manager": {
"id": 692,
"username": "joanne.koss",
"email": "[email protected]",
"name": "Cortez Ebert",
"firstname": "Cortez",
"lastname": "Ebert",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/5f83fb3b34e93a28a36278ff275d91f3?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/5f83fb3b34e93a28a36278ff275d91f3?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-04-21 13:16:05",
"updated_at": "2026-04-21 13:16:05"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete rack
requires authentication
Permanently removes a rack from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/racks/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/racks/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/racks/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Floors
List floors
requires authentication
Returns a paginated list of floors.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 89,
"name": "error",
"number": 8,
"rows": 10,
"columns": 10,
"racks": [],
"created_at": "2026-04-21 13:16:05",
"updated_at": "2026-04-21 13:16:05"
},
{
"id": 90,
"name": "fugiat",
"number": 62,
"rows": 1,
"columns": 2,
"racks": [],
"created_at": "2026-04-21 13:16:06",
"updated_at": "2026-04-21 13:16:06"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show floor
requires authentication
Display detailed information about a single floor by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/floors/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 91,
"name": "magnam",
"number": 66,
"rows": 4,
"columns": 5,
"racks": [],
"created_at": "2026-04-21 13:16:06",
"updated_at": "2026-04-21 13:16:06"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create floor
requires authentication
Store a new floor in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/floors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Floor 1\",
\"number\": 2,
\"rows\": 10,
\"columns\": 8,
\"location_id\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors'
payload = {
"name": "Floor 1",
"number": 2,
"rows": 10,
"columns": 8,
"location_id": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Floor 1',
'number' => 2,
'rows' => 10,
'columns' => 8,
'location_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 92,
"name": "tenetur",
"number": 62,
"rows": 8,
"columns": 4,
"racks": [],
"created_at": "2026-04-21 13:16:06",
"updated_at": "2026-04-21 13:16:06"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update floor
requires authentication
Updates the specified floor with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/floors/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Updated Floor 2\",
\"number\": 3,
\"rows\": 12,
\"columns\": 15,
\"location_id\": 2
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors/3'
payload = {
"name": "Updated Floor 2",
"number": 3,
"rows": 12,
"columns": 15,
"location_id": 2
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors/3';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Updated Floor 2',
'number' => 3,
'rows' => 12,
'columns' => 15,
'location_id' => 2,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 93,
"name": "molestias",
"number": 36,
"rows": 10,
"columns": 5,
"racks": [],
"created_at": "2026-04-21 13:16:07",
"updated_at": "2026-04-21 13:16:07"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete floor
requires authentication
Removes the specified floor from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/floors/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Item Models
List item models
requires authentication
Returns a paginated list of item models.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/item-models'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/item-models';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 364,
"name": "voluptatem",
"label": "delectus",
"type_id": 268,
"type": {
"id": 268,
"name": "harum"
},
"location_id": 413,
"status": "unavailable",
"description": "Deserunt doloribus accusantium autem cum consectetur.",
"is_part": false,
"mountable": true,
"manufacturer": "Maggio-Mann",
"position": "commodi",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/00cc77?text=non",
"data_ports": 5,
"serialnumber1": "4aa8420a-b380-3981-b46b-951c515d7acf",
"serialnumber2": "9ae55860-ceb8-30f2-b340-20369f4e0fb5",
"service_tag": "5da96927-cb89-32fb-a2f5-06948b142813",
"comments": "Asperiores omnis unde corporis fuga vitae. Odio veniam fugiat quia recusandae velit consequatur velit aut. Perspiciatis aut dolorem animi sit et qui officiis. In pariatur qui magni odit id earum.",
"notes": "Est debitis quisquam nobis molestias voluptates. Architecto beatae est officia iusto. Id distinctio est et cupiditate fugiat cum officiis. Qui temporibus quo et autem at.",
"purchase_date": "1998-02-16",
"warranty_months": 33,
"warranty_info": "Sed occaecati impedit vel commodi aperiam debitis non ut.",
"function": "nostrum",
"maintenance_instruction": "Illo sunt quia sed et consectetur expedita. Ab aut dignissimos non totam delectus quis et. Ut consequatur sit facere ipsa vel.",
"origin": "Micronesia",
"buy_price": 783.84,
"appdata": "a:1:{s:3:\"key\";s:3:\"est\";}",
"fields_data": "a:1:{s:5:\"field\";s:3:\"non\";}",
"parts_data": "a:1:{s:4:\"part\";s:3:\"sed\";}",
"created_at": "2026-04-21T11:16:08.000000Z",
"updated_at": "2026-04-21T11:16:08.000000Z"
},
{
"id": 365,
"name": "saepe",
"label": "ipsum",
"type_id": 269,
"type": {
"id": 269,
"name": "placeat"
},
"location_id": 414,
"status": "available",
"description": "Quia aut impedit doloribus quod minus in aut.",
"is_part": true,
"mountable": false,
"manufacturer": "Hermiston, Beer and Schultz",
"position": "aliquid",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/0077ee?text=explicabo",
"data_ports": 7,
"serialnumber1": "005a8742-b97e-3c13-86a1-1b683191df4e",
"serialnumber2": "230c7533-b747-3912-872f-c8efbf26f918",
"service_tag": "a738f072-7326-3909-92b8-b49969f7e705",
"comments": "Ipsa rerum repellendus nulla aperiam et. Officiis necessitatibus est facere eaque. Dolor pariatur facere est.",
"notes": "Sed assumenda libero dignissimos totam. Et sit illum qui aut. Ut recusandae eum dolorem tenetur enim ipsam vitae. Qui et dolor ut distinctio culpa.",
"purchase_date": "1983-10-15",
"warranty_months": 24,
"warranty_info": "Quidem facere autem voluptatem perferendis.",
"function": "minus",
"maintenance_instruction": "Rem voluptatem dignissimos voluptas quos architecto quis praesentium repellendus. Facilis delectus est ea itaque.",
"origin": "Micronesia",
"buy_price": 815.51,
"appdata": "a:1:{s:3:\"key\";s:4:\"quia\";}",
"fields_data": "a:1:{s:5:\"field\";s:7:\"dolores\";}",
"parts_data": "a:1:{s:4:\"part\";s:5:\"atque\";}",
"created_at": "2026-04-21T11:16:08.000000Z",
"updated_at": "2026-04-21T11:16:08.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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show item model
requires authentication
Display detailed information about a single item model by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/item-models/10" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/item-models/10'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/item-models/10';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 366,
"name": "quidem",
"label": "odio",
"type_id": 270,
"type": {
"id": 270,
"name": "dicta"
},
"location_id": 415,
"status": "unavailable",
"description": "Nam minima dolores ex aperiam aut qui odit.",
"is_part": true,
"mountable": false,
"manufacturer": "Schaefer-Skiles",
"position": "modi",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/00ff88?text=nihil",
"data_ports": 10,
"serialnumber1": "b549bf54-2b79-3802-a8ca-63eb3a04f86d",
"serialnumber2": "9554a568-647f-3ba2-b6a6-e656386f7b3f",
"service_tag": "efe96af6-46c2-3847-b730-9ef1473104b9",
"comments": "Consequuntur aliquid sed tenetur quo ad. Animi saepe libero deleniti aut inventore quam. Praesentium ratione sint voluptatem non odit porro natus.",
"notes": "Non ex vero repellat voluptas veniam accusamus. Voluptas dolor numquam aut illo modi sed qui mollitia. Molestiae earum provident commodi aut perferendis omnis ad.",
"purchase_date": "2023-07-13",
"warranty_months": 12,
"warranty_info": "In distinctio quia expedita molestiae consequatur.",
"function": "aut",
"maintenance_instruction": "Placeat a quaerat provident inventore laudantium doloribus velit molestiae. Dolor error repellat occaecati sed. Repellat sunt sunt et suscipit est autem numquam dolores.",
"origin": "French Guiana",
"buy_price": 866.6,
"appdata": "a:1:{s:3:\"key\";s:5:\"magni\";}",
"fields_data": "a:1:{s:5:\"field\";s:2:\"et\";}",
"parts_data": "a:1:{s:4:\"part\";s:2:\"et\";}",
"created_at": "2026-04-21T11:16:09.000000Z",
"updated_at": "2026-04-21T11:16:09.000000Z"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create item model
requires authentication
Store a new item model in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/item-models" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\": \"zpmjqw\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"sedidhzdo\",
\"notes\": \"safdztwjddavnjw\",
\"purchase_date\": \"2026-04-21T13:16:09\",
\"warranty_months\": 36,
\"warranty_info\": \"zcnixdz\",
\"function\": \"drumpojphh\",
\"maintenance_instruction\": \"h\",
\"origin\": \"fnbghcrlynidqwpoyipnnpj\",
\"buy_price\": 2500
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/item-models'
payload = {
"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": "zpmjqw",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "sedidhzdo",
"notes": "safdztwjddavnjw",
"purchase_date": "2026-04-21T13:16:09",
"warranty_months": 36,
"warranty_info": "zcnixdz",
"function": "drumpojphh",
"maintenance_instruction": "h",
"origin": "fnbghcrlynidqwpoyipnnpj",
"buy_price": 2500
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/item-models';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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' => 'zpmjqw',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'sedidhzdo',
'notes' => 'safdztwjddavnjw',
'purchase_date' => '2026-04-21T13:16:09',
'warranty_months' => 36,
'warranty_info' => 'zcnixdz',
'function' => 'drumpojphh',
'maintenance_instruction' => 'h',
'origin' => 'fnbghcrlynidqwpoyipnnpj',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 367,
"name": "repellendus",
"label": "et",
"type_id": 271,
"type": {
"id": 271,
"name": "cum"
},
"location_id": 416,
"status": "unavailable",
"description": "Aut non doloremque ut sit suscipit.",
"is_part": true,
"mountable": false,
"manufacturer": "Dooley Inc",
"position": "quo",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/0088ee?text=voluptatem",
"data_ports": 4,
"serialnumber1": "dc3638bc-8851-3364-9977-520cc9909782",
"serialnumber2": "d3f942e0-8b6d-3c02-a052-be6f4a37b3c7",
"service_tag": "10047c3d-d4f6-3ecd-a4a2-f57de7096ba8",
"comments": "Tempora aut at et consequatur. Quia neque omnis aliquam culpa rem eum ea delectus. Eligendi perferendis enim optio quia facilis fugiat voluptatum.",
"notes": "Qui incidunt sed qui sequi nisi vitae eligendi. Id non alias facere consequatur ipsa quo in. Necessitatibus enim illum voluptatem id sint.",
"purchase_date": "2012-01-05",
"warranty_months": 18,
"warranty_info": "Veritatis repudiandae aut aperiam fugiat doloremque ut.",
"function": "consequuntur",
"maintenance_instruction": "Debitis voluptas est quae omnis et. Qui aliquid reprehenderit ex quia rerum consequatur. Maiores ut sed animi tempora delectus rerum doloremque.",
"origin": "Liechtenstein",
"buy_price": 505.79,
"appdata": "a:1:{s:3:\"key\";s:2:\"at\";}",
"fields_data": "a:1:{s:5:\"field\";s:7:\"facilis\";}",
"parts_data": "a:1:{s:4:\"part\";s:4:\"sint\";}",
"created_at": "2026-04-21T11:16:09.000000Z",
"updated_at": "2026-04-21T11:16:09.000000Z"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update item model
requires authentication
Updates the specified item model with the provided request data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/item-models/12" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\": \"pdxgtxgvtazff\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"ocgboizpnbjofvuze\",
\"notes\": \"ydrvuysgxythpnqnnuaoqtmzj\",
\"purchase_date\": \"2026-04-21T13:16:09\",
\"warranty_months\": 36,
\"warranty_info\": \"qmbyrbfmvzbpxqrtbadmgri\",
\"function\": \"kmxnjrbxovrepdpgpdawfwzeo\",
\"maintenance_instruction\": \"hxgoydmm\",
\"origin\": \"dscruyynigkfuqn\",
\"buy_price\": 2500
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/item-models/12'
payload = {
"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": "pdxgtxgvtazff",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "ocgboizpnbjofvuze",
"notes": "ydrvuysgxythpnqnnuaoqtmzj",
"purchase_date": "2026-04-21T13:16:09",
"warranty_months": 36,
"warranty_info": "qmbyrbfmvzbpxqrtbadmgri",
"function": "kmxnjrbxovrepdpgpdawfwzeo",
"maintenance_instruction": "hxgoydmm",
"origin": "dscruyynigkfuqn",
"buy_price": 2500
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/item-models/12';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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' => 'pdxgtxgvtazff',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'ocgboizpnbjofvuze',
'notes' => 'ydrvuysgxythpnqnnuaoqtmzj',
'purchase_date' => '2026-04-21T13:16:09',
'warranty_months' => 36,
'warranty_info' => 'qmbyrbfmvzbpxqrtbadmgri',
'function' => 'kmxnjrbxovrepdpgpdawfwzeo',
'maintenance_instruction' => 'hxgoydmm',
'origin' => 'dscruyynigkfuqn',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 368,
"name": "voluptas",
"label": "laborum",
"type_id": 272,
"type": {
"id": 272,
"name": "omnis"
},
"location_id": 417,
"status": "in_use",
"description": "Modi qui itaque consequuntur corporis.",
"is_part": false,
"mountable": true,
"manufacturer": "Hyatt, Bruen and Hodkiewicz",
"position": "quidem",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/00ee77?text=molestiae",
"data_ports": 8,
"serialnumber1": "ec0bc439-d664-3ad7-9687-6c10cc6dc81a",
"serialnumber2": "b0c0518d-30c7-3be2-9ac1-be5fe70e46c0",
"service_tag": "eb58bef3-33d6-3da2-b048-9cfa2b29aeb1",
"comments": "Quia culpa earum id cum voluptate. Et vero corrupti quasi. Voluptate et doloribus perferendis ad ipsa.",
"notes": "Quam ipsum deserunt aut voluptatem. Eos earum at quos nostrum tempora recusandae molestias illo. Aut saepe dolor nemo.",
"purchase_date": "2017-06-05",
"warranty_months": 35,
"warranty_info": "Culpa ut quis praesentium animi ut laudantium quae voluptatum.",
"function": "deleniti",
"maintenance_instruction": "Voluptates voluptas eveniet itaque ut. Aut est id est sint. Dolores ab veritatis ipsum officia mollitia. Voluptate laborum et non excepturi.",
"origin": "Montserrat",
"buy_price": 294.47,
"appdata": "a:1:{s:3:\"key\";s:2:\"ea\";}",
"fields_data": "a:1:{s:5:\"field\";s:2:\"et\";}",
"parts_data": "a:1:{s:4:\"part\";s:3:\"eos\";}",
"created_at": "2026-04-21T11:16:09.000000Z",
"updated_at": "2026-04-21T11:16:09.000000Z"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete item model
requires authentication
Removes the specified item model from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/item-models/15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/item-models/15'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/item-models/15';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Users
List users
requires authentication
Returns a paginated list of users
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 703,
"username": "sankunding",
"email": "[email protected]",
"name": "Geraldine Ankunding",
"firstname": "Geraldine",
"lastname": "Ankunding",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/76bbfb7203fafad9a10b0772cd91fc87?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/76bbfb7203fafad9a10b0772cd91fc87?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": 704,
"username": "blaze.langosh",
"email": "[email protected]",
"name": "Maybelle Langosh",
"firstname": "Maybelle",
"lastname": "Langosh",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/6914fdbdf0146eb55af544c9da3e1e96?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/6914fdbdf0146eb55af544c9da3e1e96?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch user by email
requires authentication
Returns a user that matches the provided email.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/users/find-by-email" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/find-by-email'
payload = {
"email": "[email protected]"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/find-by-email';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => '[email protected]',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 705,
"username": "joanne61",
"email": "[email protected]",
"name": "Bennett Quitzon",
"firstname": "Bennett",
"lastname": "Quitzon",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/f0dd04100e6fc6ec6d29095d834f1cac?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/f0dd04100e6fc6ec6d29095d834f1cac?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show User
requires authentication
Updates the specified user with provided data.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/users/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 706,
"username": "hand.esta",
"email": "[email protected]",
"name": "Margie Swift",
"firstname": "Margie",
"lastname": "Swift",
"devices": [],
"orders": [],
"gender": "0",
"avatar": "//www.gravatar.com/avatar/71798a54f4e16d2f34602edfb18eddaf?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/71798a54f4e16d2f34602edfb18eddaf?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create user
requires authentication
Creates a new user account with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/users" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"username\": \"johndoe\",
\"firstname\": \"John\",
\"lastname\": \"Doe\",
\"email\": \"[email protected]\",
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users'
payload = {
"username": "johndoe",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'username' => 'johndoe',
'firstname' => 'John',
'lastname' => 'Doe',
'email' => '[email protected]',
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 707,
"username": "rwilderman",
"email": "[email protected]",
"name": "Virgie Schaefer",
"firstname": "Virgie",
"lastname": "Schaefer",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/78c07897af9aab7e90e61a7153eef5df?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/78c07897af9aab7e90e61a7153eef5df?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update User
requires authentication
Updates the specified user with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/users/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"username\": \"johndoe\",
\"firstname\": \"John\",
\"lastname\": \"Doe\",
\"email\": \"[email protected]\",
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/1'
payload = {
"username": "johndoe",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'username' => 'johndoe',
'firstname' => 'John',
'lastname' => 'Doe',
'email' => '[email protected]',
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 708,
"username": "hoeger.friedrich",
"email": "[email protected]",
"name": "Shane Marvin",
"firstname": "Shane",
"lastname": "Marvin",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/e07bd454575711ecf0b09a9f373c87f0?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/e07bd454575711ecf0b09a9f373c87f0?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User bandwidth
requires authentication
Returns an array of bandwidth usage values for a specified period of time.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/users/1/bandwidth" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start_date\": \"2025-09-22 00:00:00\",
\"end_date\": \"2025-09-22 23:59:59\",
\"device_ids\": [
14
],
\"device_selection\": \"all\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/1/bandwidth'
payload = {
"start_date": "2025-09-22 00:00:00",
"end_date": "2025-09-22 23:59:59",
"device_ids": [
14
],
"device_selection": "all"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/1/bandwidth';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'start_date' => '2025-09-22 00:00:00',
'end_date' => '2025-09-22 23:59:59',
'device_ids' => [
14,
],
'device_selection' => 'all',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete User
requires authentication
Removes the specified user from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/users/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Authentication
Verify API token and check if it has the given ability.
requires authentication
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/users/verify-token-ability" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ability\": \"impersonate-users\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/users/verify-token-ability'
payload = {
"ability": "impersonate-users"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/users/verify-token-ability';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'ability' => 'impersonate-users',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"abilities": [
"impersonate-users"
],
"valid": true
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ports
List Network Ports
requires authentication
Returns a paginated list of ports.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 3272,
"name": null,
"description": "Accusamus facilis voluptatibus praesentium quidem nobis enim aut placeat.",
"item_id": 343,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 5,
"port_index": 76,
"port_mode": "access",
"port_label": "voluptatibus",
"user_label": "velit",
"speed": "1000",
"high_speed": "100",
"if_type": "2",
"physaddress": "CA:A9:0A:58:7D:36",
"pullable": 1,
"primary": 1,
"vlan": 127,
"opstate": "up",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 1010,
"ifOutUcastPkts": 428,
"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-04-21 13:16:11",
"updated_at": "2026-04-21 13:16:11"
},
{
"id": 3273,
"name": null,
"description": "Ipsam dignissimos voluptate vel libero aut maiores.",
"item_id": 344,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 11,
"port_index": 57,
"port_mode": "trunk",
"port_label": "occaecati",
"user_label": "quo",
"speed": "10000",
"high_speed": "100",
"if_type": "222",
"physaddress": "6D:A9:E3:BE:41:C4",
"pullable": 1,
"primary": 1,
"vlan": 127,
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 1773,
"ifOutUcastPkts": 7666,
"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-04-21 13:16:12",
"updated_at": "2026-04-21 13:16:12"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Port
requires authentication
Store a new port in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ports" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3274,
"name": null,
"description": "Libero alias itaque rerum aut corporis expedita repellat voluptatibus.",
"item": {
"id": 346,
"name": null,
"label": "aliquid",
"type_id": 279,
"location_id": 427,
"status": "available",
"description": "Maiores praesentium asperiores et id quae dolore.",
"is_part": false,
"mountable": true,
"manufacturer": "Thompson LLC",
"position": null,
"size": 7,
"image": null,
"data_ports": 0,
"serialnumber1": "SN351AF",
"serialnumber2": null,
"service_tag": "ST689YT",
"comments": null,
"notes": null,
"purchase_date": "2025-04-21",
"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-04-21T11:16:14.000000Z",
"updated_at": "2026-04-21T11:16:14.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 33,
"port_index": 40,
"port_mode": "trunk",
"port_label": "qui",
"user_label": "quo",
"speed": "100",
"high_speed": "100",
"if_type": "217",
"physaddress": "AB:92:64:38:DE:15",
"pullable": 1,
"primary": 1,
"vlan": 127,
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 7464,
"ifOutUcastPkts": 9610,
"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-04-21 13:16:15",
"updated_at": "2026-04-21 13:16:15"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Port
requires authentication
Updates the specified port with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/ports/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3275,
"name": null,
"description": "Quia delectus deserunt qui sapiente esse.",
"item": {
"id": 347,
"name": null,
"label": "quia",
"type_id": 281,
"location_id": 429,
"status": "available",
"description": "Ut quisquam autem laborum vel consequatur ea delectus enim.",
"is_part": false,
"mountable": true,
"manufacturer": "Spencer and Sons",
"position": null,
"size": 6,
"image": null,
"data_ports": 0,
"serialnumber1": "SN419VS",
"serialnumber2": null,
"service_tag": "ST837WO",
"comments": null,
"notes": null,
"purchase_date": "2025-04-21",
"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-04-21T11:16:15.000000Z",
"updated_at": "2026-04-21T11:16:15.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 12,
"port_index": 80,
"port_mode": "access",
"port_label": "impedit",
"user_label": "et",
"speed": "100",
"high_speed": "100",
"if_type": "22",
"physaddress": "01:9D:F7:1B:D0:5D",
"pullable": 0,
"primary": 0,
"vlan": 127,
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 7866,
"ifOutUcastPkts": 6117,
"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-04-21 13:16:16",
"updated_at": "2026-04-21 13:16:16"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign port
requires authentication
Assign network port to another port
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ports/1/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"connected_item\": 12,
\"connected_port\": 115
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1/assign'
payload = {
"connected_item": 12,
"connected_port": 115
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1/assign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'connected_item' => 12,
'connected_port' => 115,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3276,
"name": null,
"description": "Est tempora repudiandae autem iste.",
"item": {
"id": 348,
"name": null,
"label": "odio",
"type_id": 283,
"location_id": 431,
"status": "available",
"description": "Commodi vel culpa modi et quo neque magnam magni.",
"is_part": false,
"mountable": true,
"manufacturer": "Rice, Adams and Schumm",
"position": null,
"size": 4,
"image": null,
"data_ports": 0,
"serialnumber1": "SN020JD",
"serialnumber2": null,
"service_tag": "ST822EU",
"comments": null,
"notes": null,
"purchase_date": "2025-04-21",
"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-04-21T11:16:16.000000Z",
"updated_at": "2026-04-21T11:16:16.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 28,
"port_index": 49,
"port_mode": "access",
"port_label": "neque",
"user_label": "facere",
"speed": "10000",
"high_speed": "100",
"if_type": "91",
"physaddress": "1C:4E:0F:5D:B6:0E",
"pullable": 0,
"primary": 1,
"vlan": 127,
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 6048,
"ifOutUcastPkts": 2672,
"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-04-21 13:16:18",
"updated_at": "2026-04-21 13:16:18"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unassign port
requires authentication
Unassign network port
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ports/1/unassign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1/unassign'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1/unassign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3277,
"name": null,
"description": "Rem sed velit aliquid laboriosam quia illum omnis.",
"item": null,
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 48,
"port_index": 79,
"port_mode": "trunk",
"port_label": "et",
"user_label": "optio",
"speed": "1000",
"high_speed": "10000",
"if_type": "221",
"physaddress": "A0:F9:A7:F2:04:1F",
"pullable": 1,
"primary": 0,
"vlan": 110,
"opstate": "up",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 9815,
"ifOutUcastPkts": 375,
"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-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Enable port
requires authentication
Enable port with given id.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ports/1/enable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1/enable'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1/enable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Disable port
requires authentication
Disable port with given id.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ports/1/disable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1/disable'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1/disable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Port
requires authentication
Removes the specified port from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/ports/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Power Ports
Show Power Port
requires authentication
Display detailed information about a single power port by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ports/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ports/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 353,
"name": "molestiae",
"description": "Eligendi minima fugit et necessitatibus.",
"item": {
"id": 345,
"name": null,
"label": "eaque",
"type_id": 277,
"location_id": 423,
"status": "available",
"description": "Aspernatur velit nemo a omnis ab et.",
"is_part": false,
"mountable": true,
"manufacturer": "Hodkiewicz LLC",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN781GJ",
"serialnumber2": null,
"service_tag": "ST872EO",
"comments": null,
"notes": null,
"purchase_date": "2025-04-21",
"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-04-21T11:16:12.000000Z",
"updated_at": "2026-04-21T11:16:12.000000Z"
},
"colocation": null,
"port_number": 20,
"port_label": "ex",
"user_label": "sit",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 20,
"power_usage_units": "Amps",
"power_usage_value": 20,
"power_usage_unit": "amps",
"power_usage_label": "20 Amps",
"created_at": "2026-04-21 13:16:12",
"updated_at": "2026-04-21 13:16:12"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Power Ports
requires authentication
Returns a paginated list of power ports.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 354,
"name": "voluptas",
"description": "Officia et provident repellat.",
"item_id": 366,
"colocation_id": 0,
"port_number": 26,
"port_label": "laborum",
"user_label": "ipsam",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 35,
"power_usage_units": "Amps",
"power_usage_value": 35,
"power_usage_unit": "amps",
"power_usage_label": "35 Amps",
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
},
{
"id": 355,
"name": "dolore",
"description": "Aperiam enim eius omnis hic ea eum ut.",
"item_id": 367,
"colocation_id": 0,
"port_number": 18,
"port_label": "quo",
"user_label": "et",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 92,
"power_usage_units": "Amps",
"power_usage_value": 92,
"power_usage_unit": "amps",
"power_usage_label": "92 Amps",
"created_at": "2026-04-21 13:16:38",
"updated_at": "2026-04-21 13:16: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Power Port
requires authentication
Store a new power port in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/power-ports" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 356,
"name": "et",
"description": "Pariatur asperiores modi distinctio doloremque deleniti.",
"item": null,
"colocation": null,
"port_number": 18,
"port_label": "dolorum",
"user_label": "sit",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 96,
"power_usage_units": "Amps",
"power_usage_value": 96,
"power_usage_unit": "amps",
"power_usage_label": "96 Amps",
"created_at": "2026-04-21 13:16:40",
"updated_at": "2026-04-21 13:16:40"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Power Port
requires authentication
Updates the specified power port with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/power-ports/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"port_number\": 1,
\"port_label\": 32,
\"primary\": true,
\"description\": \"This is description of the power port\",
\"user_label\": \"Description of power port\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports/1'
payload = {
"port_number": 1,
"port_label": 32,
"primary": true,
"description": "This is description of the power port",
"user_label": "Description of power port"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'port_number' => 1,
'port_label' => 32,
'primary' => true,
'description' => 'This is description of the power port',
'user_label' => 'Description of power port',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 357,
"name": "optio",
"description": "Aut non eligendi aut molestiae delectus.",
"item": null,
"colocation": null,
"port_number": 7,
"port_label": "ducimus",
"user_label": "placeat",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 23,
"power_usage_units": "Amps",
"power_usage_value": 23,
"power_usage_unit": "amps",
"power_usage_label": "23 Amps",
"created_at": "2026-04-21 13:16:43",
"updated_at": "2026-04-21 13:16:43"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign Power Port
requires authentication
Assign power port to another port
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/power-ports/1/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"connected_item\": 12,
\"connected_port\": 115
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/assign'
payload = {
"connected_item": 12,
"connected_port": 115
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/assign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'connected_item' => 12,
'connected_port' => 115,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 358,
"name": "quaerat",
"description": "Et facere ea dolorem et quibusdam harum aut.",
"item": null,
"colocation": null,
"port_number": 13,
"port_label": "quas",
"user_label": "qui",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 69,
"power_usage_units": "Amps",
"power_usage_value": 69,
"power_usage_unit": "amps",
"power_usage_label": "69 Amps",
"created_at": "2026-04-21 13:16:45",
"updated_at": "2026-04-21 13:16:45"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unassign Power Port
requires authentication
Unassigns power port
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/power-ports/1/unassign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/unassign'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/unassign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 359,
"name": "neque",
"description": "Dolores rerum nihil quia qui autem.",
"item": {
"id": 371,
"name": null,
"label": "doloribus",
"type_id": 329,
"location_id": 487,
"status": "available",
"description": "Ut eveniet sunt animi animi repellendus pariatur.",
"is_part": false,
"mountable": true,
"manufacturer": "Walker, Mueller and Ferry",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN370OZ",
"serialnumber2": null,
"service_tag": "ST986DH",
"comments": null,
"notes": null,
"purchase_date": "2025-04-21",
"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-04-21T11:16:47.000000Z",
"updated_at": "2026-04-21T11:16:47.000000Z"
},
"colocation": null,
"port_number": 15,
"port_label": "expedita",
"user_label": "voluptas",
"outlet_state": "down",
"connected_item": null,
"connected_port": null,
"power_usage": 71,
"power_usage_units": "Amps",
"power_usage_value": 71,
"power_usage_unit": "amps",
"power_usage_label": "71 Amps",
"created_at": "2026-04-21 13:16:47",
"updated_at": "2026-04-21 13:16:47"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Perform action on a specific Power Port
requires authentication
Executes an outlet action (outletOn, outletOff, outletReboot) for a given port.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/power-ports/1/action" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"action\": \"outletOff\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/action'
payload = {
"action": "outletOff"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports/1/action';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'action' => 'outletOff',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 360,
"name": "tempora",
"description": "Consequatur molestiae enim placeat corrupti incidunt.",
"item": null,
"colocation": null,
"port_number": 7,
"port_label": "sequi",
"user_label": "et",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 44,
"power_usage_units": "Amps",
"power_usage_value": 44,
"power_usage_unit": "amps",
"power_usage_label": "44 Amps",
"created_at": "2026-04-21 13:16:49",
"updated_at": "2026-04-21 13:16:49"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Power Port
requires authentication
Removes the specified power port from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/power-ports/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/power-ports/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/power-ports/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Orders
List orders
requires authentication
Returns a paginated list of orders
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 75,
"ordernumber": 391509,
"user_id": 734,
"status": "accepted",
"service_status": "activated",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
},
{
"id": 76,
"ordernumber": 47928,
"user_id": 735,
"status": "accepted",
"service_status": "activated",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show order
requires authentication
Display detailed information about a single order by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/orders/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 77,
"ordernumber": 928973,
"user_id": 736,
"status": "accepted",
"service_status": "waiting",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create order
requires authentication
Creates a new order in the system based on the given module, client, and criteria.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"module\": \"Server\",
\"client\": 1,
\"auto_accept\": true
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders'
payload = {
"module": "Server",
"client": 1,
"auto_accept": true
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'module' => 'Server',
'client' => 1,
'auto_accept' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 78,
"ordernumber": 534081,
"user_id": 737,
"status": "accepted",
"service_status": "terminated",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Quick create & activate order
requires authentication
Creates a new order for a specific device and customer. The order is automatically accepted and the device assigned.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/quick-create" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"module\": \"Server\",
\"client\": 1,
\"device_id\": 10
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/quick-create'
payload = {
"module": "Server",
"client": 1,
"device_id": 10
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/quick-create';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'module' => 'Server',
'client' => 1,
'device_id' => 10,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 79,
"ordernumber": 880806,
"user_id": 738,
"status": "pending",
"service_status": "provisioning",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update order
requires authentication
Update order details before it is accepted.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/orders/123" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/123'
payload = {
"client": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/123';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'client' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 80,
"ordernumber": 766249,
"user_id": 739,
"status": "pending",
"service_status": "waiting",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete order
requires authentication
Deletes an order by ID.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/orders/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Accept order
requires authentication
Accepts an order by ID and optionally activates the service if configured.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/1/accept" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1/accept'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1/accept';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 81,
"ordernumber": 465524,
"user_id": 740,
"status": "pending",
"service_status": "terminated",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-04-21 13:16:19",
"updated_at": "2026-04-21 13:16:19"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Activate service
requires authentication
Activates the service assigned to the specified order.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/1/service/activate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/activate'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/activate';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Suspend service
requires authentication
Suspends the service assigned to the specified order.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/1/service/suspend" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/suspend'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/suspend';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unsuspend service
requires authentication
Unsuspends the service assigned to the specified order.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/1/service/unsuspend" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/unsuspend'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/unsuspend';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Terminate service
requires authentication
Terminates the service belonging to the specified order.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/1/service/terminate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/terminate'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/1/service/terminate';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List provisioning logs
requires authentication
Returns a paginated list of provisioning logs for a given order.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/orders/123/provisioning-logs?per_page=10&page=1&sort_by=date_string&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=message" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/123/provisioning-logs'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'date_string',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'message',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/123/provisioning-logs';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'date_string',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'message',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get order actions
requires authentication
Returns available global and module-specific actions for the given module type and action.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/orders/actions/list?type=Server&action=activate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"Colocation\",
\"action\": \"terminate\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/actions/list'
payload = {
"type": "Colocation",
"action": "terminate"
}
params = {
'type': 'Server',
'action': 'activate',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, json=payload, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/actions/list';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'type' => 'Server',
'action' => 'activate',
],
'json' => [
'type' => 'Colocation',
'action' => 'terminate',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Devices in Stock Based on Criteria
requires authentication
Returns a devices in stock number based on order criteria
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/orders/stock" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
]
}
}
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/stock'
payload = {
"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
]
}
}
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/stock';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'criteria' => [
'model' => 12,
'location' => 12,
'require_parts' => 1,
'parts' => [
8 => [
'model' => [
16,
12,
],
'hdd.size' => [
1048576,
2048576,
],
],
[
'model' => [
25,
21,
],
'ssd.size' => [
'524288|1048576',
524288,
],
],
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"stock": 10
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Device Bays
List Device Bays
requires authentication
Returns a paginated list of device bays.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/device-bays'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/device-bays';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 15,
"name": "Ms. Donna Hegmann I",
"order": 2,
"parent_id": 351,
"child_id": 350,
"created_at": "2026-04-21 13:16:22",
"updated_at": "2026-04-21 13:16:22"
},
{
"id": 16,
"name": "Jaylon O'Kon",
"order": 6,
"parent_id": 353,
"child_id": 352,
"created_at": "2026-04-21 13:16:23",
"updated_at": "2026-04-21 13:16:23"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Device Bay
requires authentication
Display detailed information about a single device bay by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/device-bays/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/device-bays/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/device-bays/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 17,
"name": "Dr. Reggie Kozey DVM",
"order": 5,
"parent": {
"id": 355,
"label": "ut",
"model": "placeat",
"product_id": 0,
"model_id": 394,
"parent_id": 0,
"type_id": 6,
"user_id": 757,
"order_id": 0,
"location_id": 445,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Brown, Marks and Wilderman",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"child": {
"id": 354,
"label": "suscipit",
"model": "beatae",
"product_id": 0,
"model_id": 392,
"parent_id": 0,
"type_id": 293,
"user_id": 754,
"order_id": 0,
"location_id": 445,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Brown, Marks and Wilderman",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"created_at": "2026-04-21 13:16:26",
"updated_at": "2026-04-21 13:16:26"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Device Bay
requires authentication
Store a new device bay in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/device-bays" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"First Device Bay\",
\"parent_id\": 10,
\"child_id\": 18,
\"order\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/device-bays'
payload = {
"name": "First Device Bay",
"parent_id": 10,
"child_id": 18,
"order": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/device-bays';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'First Device Bay',
'parent_id' => 10,
'child_id' => 18,
'order' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 18,
"name": "Prof. Jeramy Abernathy",
"order": 9,
"parent": {
"id": 357,
"label": "est",
"model": "nihil",
"product_id": 0,
"model_id": 398,
"parent_id": 0,
"type_id": 6,
"user_id": 763,
"order_id": 0,
"location_id": 449,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Spencer, Cormier and Christiansen",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"child": {
"id": 356,
"label": "architecto",
"model": "dolorem",
"product_id": 0,
"model_id": 396,
"parent_id": 0,
"type_id": 296,
"user_id": 760,
"order_id": 0,
"location_id": 449,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Spencer, Cormier and Christiansen",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"created_at": "2026-04-21 13:16:28",
"updated_at": "2026-04-21 13:16:28"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Device Bay
requires authentication
Updates the specified device bay with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/device-bays/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"First Device Bay\",
\"child_id\": 18,
\"order\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/device-bays/1'
payload = {
"name": "First Device Bay",
"child_id": 18,
"order": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/device-bays/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'First Device Bay',
'child_id' => 18,
'order' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 19,
"name": "Rita Bernier",
"order": 8,
"parent": {
"id": 359,
"label": "voluptatum",
"model": "molestiae",
"product_id": 0,
"model_id": 402,
"parent_id": 0,
"type_id": 6,
"user_id": 769,
"order_id": 0,
"location_id": 453,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Weber, Hagenes and Zieme",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"child": {
"id": 358,
"label": "dolorum",
"model": "quia",
"product_id": 0,
"model_id": 400,
"parent_id": 0,
"type_id": 299,
"user_id": 766,
"order_id": 0,
"location_id": 453,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Weber, Hagenes and Zieme",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Device Bay
requires authentication
Removes the specified device bay from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/device-bays/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/device-bays/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/device-bays/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Item Types
List Item Types
requires authentication
Returns a paginated list of item types.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/types'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 302,
"name": "fuga",
"description": "Consequatur laborum sint atque qui nemo ratione.",
"hardware": 1,
"software": 0,
"predefined": 1,
"color": "fuchsia",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
},
{
"id": 303,
"name": "harum",
"description": "Quia sed ea tempore assumenda repellat excepturi accusantium.",
"hardware": 0,
"software": 1,
"predefined": 1,
"color": "navy",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Item Type
requires authentication
Display detailed information about a single item type by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/types/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/types/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/types/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 304,
"name": "incidunt",
"description": "Totam qui animi asperiores ea accusantium magnam omnis quia.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "blue",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Item Type
requires authentication
Store a new item type in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/types" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Blade\",
\"description\": \"Blade type description\",
\"group\": \"hardware\",
\"color\": \"#A8DBA8\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/types'
payload = {
"name": "Blade",
"description": "Blade type description",
"group": "hardware",
"color": "#A8DBA8"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/types';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Blade',
'description' => 'Blade type description',
'group' => 'hardware',
'color' => '#A8DBA8',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 305,
"name": "qui",
"description": "Provident dolores quaerat quo odio.",
"hardware": 0,
"software": 1,
"predefined": 0,
"color": "gray",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Item Type
requires authentication
Updates the specified item type with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/types/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Blade\",
\"description\": \"Blade type description\",
\"group\": \"hardware\",
\"color\": \"#A8DBA8\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/types/1'
payload = {
"name": "Blade",
"description": "Blade type description",
"group": "hardware",
"color": "#A8DBA8"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/types/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Blade',
'description' => 'Blade type description',
'group' => 'hardware',
'color' => '#A8DBA8',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 306,
"name": "sequi",
"description": "Aut et blanditiis laborum sit dicta qui.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "maroon",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Item type
requires authentication
Removes the specified item type from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/types/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/types/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/types/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Groups
List Groups
requires authentication
Returns a paginated list of groups.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/groups'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/groups';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 14,
"title": "Prof. Verdie Zulauf"
},
{
"id": 15,
"title": "Prof. Melyna O'Hara"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Permissions
requires authentication
Returns a paginated list of permissions.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/permissions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/permissions'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/permissions';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 458,
"name": "maxime.reprehenderit.quia",
"display_name": "Adriana Klein",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
},
{
"id": 459,
"name": "harum.magni.voluptas",
"display_name": "Mr. Rhiannon Zemlak IV",
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
}
]
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Group
requires authentication
Display detailed information about a single group by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/groups/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/groups/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/groups/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 16,
"title": "Gordon Hoppe",
"permissions": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Group
requires authentication
Store a new group in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Employees\",
\"permissions\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/groups'
payload = {
"title": "Employees",
"permissions": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/groups';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Employees',
'permissions' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 17,
"title": "Emilia Rice",
"permissions": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Group
requires authentication
Updates the specified group with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/groups/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Employees\",
\"permissions\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/groups/1'
payload = {
"title": "Employees",
"permissions": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/groups/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Employees',
'permissions' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 18,
"title": "Dr. Lucienne Rolfson",
"permissions": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Group
requires authentication
Removes the specified group from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/groups/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/groups/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/groups/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Items
List Items
requires authentication
Returns a paginated list of items.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 360,
"model_id": 404,
"parent_id": 0,
"type_id": 307,
"user_id": 772,
"location_id": 455,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"model": "consequatur",
"manufacturer": "Haley Ltd",
"serialnumber1": "SN319BQ",
"serialnumber2": null,
"service_tag": "ST394DJ",
"comments": null,
"label": "sed",
"description": "Enim aut quis soluta culpa nihil autem.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:30",
"updated_at": "2026-04-21 13:16:30"
},
{
"id": 361,
"model_id": 406,
"parent_id": 0,
"type_id": 309,
"user_id": 775,
"location_id": 457,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"model": "magni",
"manufacturer": "O'Hara Ltd",
"serialnumber1": "SN665BE",
"serialnumber2": null,
"service_tag": "ST436NY",
"comments": null,
"label": "omnis",
"description": "Nulla dicta debitis animi expedita.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:31",
"updated_at": "2026-04-21 13:16: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Item
requires authentication
Display detailed information about a single item by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/items/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 362,
"model": {
"id": 408,
"name": "voluptatem",
"label": null,
"type_id": 311,
"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-04-21T11:16:33.000000Z",
"updated_at": "2026-04-21T11:16:33.000000Z"
},
"user": {
"id": 778,
"username": "jovan.damore",
"email": "[email protected]",
"name": "Flo Herzog",
"firstname": "Flo",
"lastname": "Herzog",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/3f047949ec7dac7880cd75c7b405f69b?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/3f047949ec7dac7880cd75c7b405f69b?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": 311,
"name": "natus",
"description": "Officiis magni natus mollitia quo delectus perspiciatis eveniet non.",
"hardware": 1,
"software": 1,
"predefined": 0,
"color": "teal",
"created_at": "2026-04-21 13:16:32",
"updated_at": "2026-04-21 13:16:32"
},
"parent": null,
"location": {
"id": 459,
"app_id": null,
"name": "Huels-Dickinson",
"address": "20574 Willis Wells Suite 426\nSouth Kirstin, IA 40459-1823",
"city": "Port Clairland",
"state": "Missouri",
"description": "Ipsa praesentium est reiciendis neque dolores esse suscipit modi. Nisi vitae enim dolores. Ut accusantium rem qui. Numquam aliquam expedita qui tempore.",
"notes": "Voluptas eum omnis aut deserunt optio est. Modi quod incidunt rem illum aspernatur. In ab in atque minima assumenda. Quo ipsum modi tenetur doloribus perferendis.",
"emergency": "1",
"phone": "1-631-325-7113",
"flag": "Canada.png",
"created_at": "2026-04-21 13:16:33",
"updated_at": "2026-04-21 13:16:33"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"manufacturer": "Cole-Leffler",
"serialnumber1": "SN181WP",
"serialnumber2": null,
"service_tag": "ST300TW",
"comments": null,
"label": "culpa",
"description": "Sit dolor corrupti est omnis culpa recusandae.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:32",
"updated_at": "2026-04-21 13:16:32"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Item QR Code
requires authentication
Display QR code for item by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/items/1/qrcode?size=300" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items/1/qrcode'
params = {
'size': '300',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items/1/qrcode';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'size' => '300',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Item
requires authentication
Store a new item in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/items" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items'
payload = {
"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"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 363,
"model": {
"id": 410,
"name": "in",
"label": null,
"type_id": 313,
"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-04-21T11:16:34.000000Z",
"updated_at": "2026-04-21T11:16:34.000000Z"
},
"user": {
"id": 781,
"username": "aufderhar.emelie",
"email": "[email protected]",
"name": "Karley Johnston",
"firstname": "Karley",
"lastname": "Johnston",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/cdba51392dd4e8088dbd6c2d1c811f8a?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/cdba51392dd4e8088dbd6c2d1c811f8a?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": 313,
"name": "doloribus",
"description": "Nihil est quia amet facere impedit aut.",
"hardware": 0,
"software": 0,
"predefined": 1,
"color": "aqua",
"created_at": "2026-04-21 13:16:33",
"updated_at": "2026-04-21 13:16:33"
},
"parent": null,
"location": {
"id": 461,
"app_id": null,
"name": "Heidenreich Ltd",
"address": "694 David Land Suite 359\nClotildefort, AL 89222-1213",
"city": "North Riley",
"state": "California",
"description": "Aut blanditiis tempora enim est nesciunt. Omnis saepe ab aliquam et totam placeat aut sit. Quas deleniti nobis est repellendus veniam cumque. Doloribus rerum quasi illum nam neque veniam excepturi.",
"notes": "Omnis beatae voluptatem fugiat temporibus. Accusamus eligendi sed ut. Ut ducimus voluptatibus est veritatis odio aut. Quisquam consequuntur numquam laudantium et.",
"emergency": "0",
"phone": "+15419331247",
"flag": "Germany.png",
"created_at": "2026-04-21 13:16:34",
"updated_at": "2026-04-21 13:16:34"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Simonis, Hartmann and Carter",
"serialnumber1": "SN076SP",
"serialnumber2": null,
"service_tag": "ST872BG",
"comments": null,
"label": "voluptatibus",
"description": "Similique tempore iusto enim quia.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:33",
"updated_at": "2026-04-21 13:16:33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Item
requires authentication
Updates the specified item with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/items/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items/1'
payload = {
"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"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 364,
"model": {
"id": 412,
"name": "aut",
"label": null,
"type_id": 315,
"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-04-21T11:16:35.000000Z",
"updated_at": "2026-04-21T11:16:35.000000Z"
},
"user": {
"id": 784,
"username": "vladimir.terry",
"email": "[email protected]",
"name": "Celestine Johnson",
"firstname": "Celestine",
"lastname": "Johnson",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/f4a9cd0bc98525ba5fe6f3707b11000e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/f4a9cd0bc98525ba5fe6f3707b11000e?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": 315,
"name": "nesciunt",
"description": "Consequuntur dignissimos distinctio quas laborum et vero.",
"hardware": 1,
"software": 1,
"predefined": 0,
"color": "lime",
"created_at": "2026-04-21 13:16:34",
"updated_at": "2026-04-21 13:16:34"
},
"parent": null,
"location": {
"id": 463,
"app_id": null,
"name": "Kunde and Sons",
"address": "47625 Kuhic Row Apt. 088\nPort Borisshire, ND 94781-2734",
"city": "North Sydnie",
"state": "Utah",
"description": "Quasi et voluptatibus error consequatur. Vitae quidem delectus maiores ut repellat. Asperiores aut est fugiat odit.",
"notes": "Aut veniam reiciendis omnis. Accusamus ea tempore id sequi voluptates. Alias dicta harum corrupti. Et vel quo corporis quis eos et at.",
"emergency": "0",
"phone": "802.593.2877",
"flag": "UK.png",
"created_at": "2026-04-21 13:16:35",
"updated_at": "2026-04-21 13:16:35"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"manufacturer": "Boyer LLC",
"serialnumber1": "SN465VB",
"serialnumber2": null,
"service_tag": "ST707GY",
"comments": null,
"label": "quaerat",
"description": "Velit enim dolor sunt magni perspiciatis dolor quidem.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:34",
"updated_at": "2026-04-21 13:16:34"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign Metadata To Item
requires authentication
Assigns metadata for specified item.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/items/1/metadata/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"ipmi.ip\",
\"value\": \"192.168.56.180\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items/1/metadata/assign'
payload = {
"slug": "ipmi.ip",
"value": "192.168.56.180"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items/1/metadata/assign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'slug' => 'ipmi.ip',
'value' => '192.168.56.180',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 365,
"model": {
"id": 414,
"name": "placeat",
"label": null,
"type_id": 317,
"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-04-21T11:16:36.000000Z",
"updated_at": "2026-04-21T11:16:36.000000Z"
},
"user": {
"id": 787,
"username": "bradtke.flo",
"email": "[email protected]",
"name": "Fiona Schroeder",
"firstname": "Fiona",
"lastname": "Schroeder",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/89c94430d06b049a465fac686243ce68?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/89c94430d06b049a465fac686243ce68?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": 317,
"name": "dolorum",
"description": "Velit molestias ea ipsam est fugiat.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "fuchsia",
"created_at": "2026-04-21 13:16:35",
"updated_at": "2026-04-21 13:16:35"
},
"parent": null,
"location": {
"id": 465,
"app_id": null,
"name": "Dicki, Paucek and Monahan",
"address": "844 Brannon Street\nLilliechester, KY 64437",
"city": "Port Queenie",
"state": "Delaware",
"description": "Porro odit qui aperiam aut quia doloribus perspiciatis. Ullam quia natus dolore adipisci quo quia voluptatum. In et ullam velit optio rem omnis. Numquam cumque aut voluptas fuga voluptatibus.",
"notes": "In aut id rerum ut nihil debitis. Aut beatae magni natus nam maiores sed. Laudantium consequatur aut voluptas ut beatae rem. Dolor quas adipisci in recusandae.",
"emergency": "1",
"phone": "586.518.4121",
"flag": "Canada.png",
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"manufacturer": "Price, Hoppe and Prohaska",
"serialnumber1": "SN113FD",
"serialnumber2": null,
"service_tag": "ST572OJ",
"comments": null,
"label": "amet",
"description": "Consequatur aut enim quia adipisci qui voluptatum.",
"purchase_date": "2025-04-21",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-04-21 13:16:35",
"updated_at": "2026-04-21 13:16:35"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Item
requires authentication
Removes the specified item from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/items/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/items/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/items/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Item Type Fields
List Item Type Fields
requires authentication
Returns a paginated list of item type fields.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/fields'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/fields';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 99,
"related_type": null,
"element": "textarea",
"group": "Base",
"slug": "dolores.aut.eos",
"label": "Dejuan Reilly",
"options": {
"dicta reiciendis quia omnis sunt": "dicta reiciendis quia omnis sunt"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 0,
"encrypted": 1,
"additional_rules": [
"consequuntur",
"quia",
"aliquid",
"maxime",
"perferendis"
],
"order": 5,
"types": [],
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
},
{
"id": 100,
"related_type": null,
"element": "dropdown",
"group": "Base",
"slug": "similique.qui.autem",
"label": "Jonatan Dietrich",
"options": {
"neque nulla adipisci error voluptatem": "neque nulla adipisci error voluptatem"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 0,
"encrypted": 1,
"additional_rules": [
"nostrum",
"eum",
"quidem",
"nesciunt",
"ut"
],
"order": 54,
"types": [],
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Item Type Field
requires authentication
Display detailed information about a single item type field by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/fields/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/fields/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/fields/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 101,
"related_type": null,
"element": "dropdown",
"group": "Base",
"slug": "aperiam.quod.quis",
"label": "Sean Haley Sr.",
"options": {
"omnis non dignissimos tempora consequatur": "omnis non dignissimos tempora consequatur"
},
"predefined": 1,
"hidden": 0,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"sint",
"deleniti",
"ratione",
"autem",
"exercitationem"
],
"order": 44,
"values": [],
"types": [],
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Item Type Field
requires authentication
Store a new item type field in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/fields'
payload = {
"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
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/fields';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 102,
"related_type": null,
"element": "textarea",
"group": "Base",
"slug": "corporis.laboriosam.totam",
"label": "Aglae Greenholt MD",
"options": {
"aliquam eligendi omnis et perferendis": "aliquam eligendi omnis et perferendis"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"aperiam",
"qui",
"qui",
"in",
"rerum"
],
"order": 88,
"values": [],
"types": [],
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Item Type Field
requires authentication
Updates the specified item type field with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/fields/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/fields/1'
payload = {
"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
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/fields/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 103,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "qui.commodi.occaecati",
"label": "Elza Gleason III",
"options": {
"molestias aut omnis rerum nihil": "molestias aut omnis rerum nihil"
},
"predefined": 0,
"hidden": 1,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"fugiat",
"voluptas",
"expedita",
"sit",
"culpa"
],
"order": 66,
"values": [],
"types": [],
"created_at": "2026-04-21 13:16:36",
"updated_at": "2026-04-21 13:16:36"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Item Type Field
requires authentication
Removes the specified item type field from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/fields/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/fields/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/fields/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Sensors
List Sensors
requires authentication
Returns a paginated list of sensors.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/sensors'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/sensors';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 66,
"item_id": 373,
"name": "eveniet",
"class": "Power Supply",
"type": "Power",
"unit": "RPM",
"index": "Power",
"reading": 492,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:16:53",
"updated_at": "2026-04-21 13:16:53"
},
{
"id": 67,
"item_id": 374,
"name": "explicabo",
"class": "Power Supply",
"type": "Power",
"unit": "Watts",
"index": "Power",
"reading": 299,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:16:54",
"updated_at": "2026-04-21 13:16:54"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show sensor
requires authentication
Display detailed information about a single sensor by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/sensors/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/sensors/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/sensors/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 68,
"item_id": 375,
"name": "sit",
"class": "Fans",
"type": "Thermal",
"unit": "Celsius",
"index": "Thermal",
"reading": 625,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:16:55",
"updated_at": "2026-04-21 13:16:55"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Sensor
requires authentication
Removes the specified sensor from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/sensors/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/sensors/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/sensors/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Access Levels
List Services Access Levels
requires authentication
Returns a paginated list of access levels.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/service-access-levels'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/service-access-levels';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 16,
"name": "vero",
"type": "Server",
"default": 1,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"position\";i:1;s:8:\"location\";i:2;s:11:\"description\";i:3;s:5:\"model\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:17:\"widget_last_month\";i:1;s:20:\"widget_network_ports\";i:2;s:17:\"left_sidebar_link\";i:3;s:23:\"widget_last_month_graph\";i:4;s:9:\"filtering\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:20:\"widget_average_usage\";i:2;s:7:\"outlets\";i:3;s:23:\"widget_last_month_graph\";i:4;s:17:\"left_sidebar_link\";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:22:\"rdns_left_sidebar_link\";i:1;s:11:\"delete_rdns\";i:2;s:11:\"create_rdns\";i:3;s:11:\"update_rdns\";}}"
},
{
"id": 17,
"name": "laboriosam",
"type": "Colocation",
"default": 0,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:11:\"description\";i:1;s:8:\"location\";i:2;s:8:\"position\";i:3;s:5:\"model\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:20:\"widget_network_ports\";i:1;s:17:\"left_sidebar_link\";i:2;s:23:\"widget_last_month_graph\";i:3;s:9:\"filtering\";i:4;s:17:\"widget_last_month\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:17:\"left_sidebar_link\";i:2;s:7:\"outlets\";i:3;s:20:\"widget_average_usage\";i:4;s:23:\"widget_last_month_graph\";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:22:\"rdns_left_sidebar_link\";i:1;s:11:\"update_rdns\";i:2;s:11:\"delete_rdns\";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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Devices
List Devices
requires authentication
Returns a paginated list of devices.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 376,
"label": "laudantium",
"model": "consequatur",
"product_id": 0,
"model_id": 436,
"parent_id": 0,
"type_id": 339,
"user_id": 848,
"order_id": 89,
"location_id": 501,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Monahan, Jaskolski and Mertz",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null
},
{
"id": 377,
"label": "sint",
"model": "iste",
"product_id": 0,
"model_id": 438,
"parent_id": 0,
"type_id": 341,
"user_id": 855,
"order_id": 90,
"location_id": 505,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Heller-Hodkiewicz",
"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": "<span class=\"edc-badge edc-badge-muted\">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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Device
requires authentication
Display detailed information about a single device by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/devices/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 378,
"product_id": 0,
"model_id": 440,
"parent_id": 0,
"type_id": 343,
"user_id": 862,
"order_id": 91,
"location_id": 509,
"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": "Bode PLC",
"serialnumber1": "SN466BI",
"serialnumber2": null,
"service_tag": "ST100WW",
"comments": null,
"label": "mollitia",
"description": "Aperiam consequuntur qui natus velit.",
"ip_addresses": [],
"purchase_date": "2025-04-21",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"metadata": [],
"device_traffic": null,
"type": {
"id": 343,
"name": "nesciunt",
"description": "Nesciunt perspiciatis a doloribus.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "aqua",
"created_at": "2026-04-21 13:17:00",
"updated_at": "2026-04-21 13:17:00"
},
"model": {
"id": 440,
"name": "dicta",
"label": null,
"type_id": 343,
"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-04-21T11:17:02.000000Z",
"updated_at": "2026-04-21T11:17:02.000000Z"
},
"user": {
"id": 862,
"username": "kohara",
"email": "[email protected]",
"name": "Emmitt Keebler",
"firstname": "Emmitt",
"lastname": "Keebler",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/b245e83607f2edf877f1b350285e092a?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/b245e83607f2edf877f1b350285e092a?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": 509,
"app_id": null,
"name": "Hudson Ltd",
"address": "6071 Stephen Branch Apt. 174\nSouth Retashire, GA 84381",
"city": "East Daisy",
"state": "Wyoming",
"description": "Accusantium neque ullam temporibus aut nostrum. Sapiente voluptatibus in possimus dolorem totam ut.",
"notes": "Qui molestias beatae eveniet exercitationem tempora enim repellat. Sed adipisci mollitia voluptatem soluta est qui. Ducimus doloremque quidem et illo et quam.",
"emergency": "0",
"phone": "+1.806.515.4241",
"flag": "Canada.png",
"created_at": "2026-04-21 13:17:01",
"updated_at": "2026-04-21 13:17:01"
},
"rack": null,
"parent": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Device
requires authentication
Store a new device in the system using validated request data.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices'
payload = {
"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"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 379,
"product_id": 0,
"model_id": 442,
"parent_id": 0,
"type_id": 345,
"user_id": 869,
"order_id": 92,
"location_id": 513,
"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": "Donnelly-Ruecker",
"serialnumber1": "SN338DF",
"serialnumber2": null,
"service_tag": "ST956DO",
"comments": null,
"label": "alias",
"description": "Neque est dicta repellendus est et et.",
"ip_addresses": [],
"purchase_date": "2025-04-21",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"metadata": [],
"device_traffic": null,
"type": {
"id": 345,
"name": "dolores",
"description": "Delectus vitae soluta velit quaerat.",
"hardware": 0,
"software": 0,
"predefined": 1,
"color": "blue",
"created_at": "2026-04-21 13:17:02",
"updated_at": "2026-04-21 13:17:02"
},
"model": {
"id": 442,
"name": "sequi",
"label": null,
"type_id": 345,
"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-04-21T11:17:04.000000Z",
"updated_at": "2026-04-21T11:17:04.000000Z"
},
"user": {
"id": 869,
"username": "little.shemar",
"email": "[email protected]",
"name": "Augustus Christiansen",
"firstname": "Augustus",
"lastname": "Christiansen",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/9532559b9dcced09c2bf7e9263a7d65c?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/9532559b9dcced09c2bf7e9263a7d65c?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": 513,
"app_id": null,
"name": "Medhurst, Grady and Schumm",
"address": "65039 Scottie Terrace\nSouth Rosalia, FL 20832-0604",
"city": "East Telly",
"state": "North Dakota",
"description": "Voluptate natus aliquam perspiciatis est esse. Dolores enim voluptatum maiores nisi maxime ut qui. Ea molestiae nesciunt quis sequi.",
"notes": "Maiores est voluptates incidunt et omnis beatae voluptatem. Dignissimos molestiae mollitia quod architecto. Non dignissimos eaque qui repellat ea maiores consequatur.",
"emergency": "0",
"phone": "1-386-329-7916",
"flag": "Germany.png",
"created_at": "2026-04-21 13:17:03",
"updated_at": "2026-04-21 13:17:03"
},
"rack": null,
"parent": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Device
requires authentication
Updates the specified device with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/devices/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/1'
payload = {
"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"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 380,
"product_id": 0,
"model_id": 444,
"parent_id": 0,
"type_id": 347,
"user_id": 876,
"order_id": 93,
"location_id": 517,
"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": "McClure Group",
"serialnumber1": "SN562DH",
"serialnumber2": null,
"service_tag": "ST060QH",
"comments": null,
"label": "fugit",
"description": "Explicabo ad omnis natus nobis molestiae dolores quod ipsam.",
"ip_addresses": [],
"purchase_date": "2025-04-21",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"metadata": [],
"device_traffic": null,
"type": {
"id": 347,
"name": "aut",
"description": "Occaecati facilis consequatur vitae ipsum illo error.",
"hardware": 0,
"software": 1,
"predefined": 1,
"color": "navy",
"created_at": "2026-04-21 13:17:04",
"updated_at": "2026-04-21 13:17:04"
},
"model": {
"id": 444,
"name": "totam",
"label": null,
"type_id": 347,
"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-04-21T11:17:05.000000Z",
"updated_at": "2026-04-21T11:17:05.000000Z"
},
"user": {
"id": 876,
"username": "marc90",
"email": "[email protected]",
"name": "Samantha Hansen",
"firstname": "Samantha",
"lastname": "Hansen",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/55bf460b2cdafb48b729060686b40a48?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/55bf460b2cdafb48b729060686b40a48?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": 517,
"app_id": null,
"name": "Jones-Oberbrunner",
"address": "9323 O'Kon Junction Apt. 782\nDoylebury, NE 72384-6516",
"city": "West Willie",
"state": "West Virginia",
"description": "Id repellendus architecto voluptatem quibusdam tempora. Ipsam nesciunt autem aut iusto. Ut ut qui quia minima aut vel temporibus.",
"notes": "Sunt autem deleniti exercitationem officiis earum. Harum eaque cupiditate eaque. Minima perferendis ducimus aut magnam molestias eius.",
"emergency": "1",
"phone": "1-580-234-7485",
"flag": "Germany.png",
"created_at": "2026-04-21 13:17:05",
"updated_at": "2026-04-21 13:17:05"
},
"rack": null,
"parent": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign Metadata To Device
requires authentication
Assigns metadata for specified device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/1/metadata/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"ipmi.ip\",
\"value\": \"192.168.56.180\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/1/metadata/assign'
payload = {
"slug": "ipmi.ip",
"value": "192.168.56.180"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/1/metadata/assign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'slug' => 'ipmi.ip',
'value' => '192.168.56.180',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 381,
"product_id": 0,
"model_id": 446,
"parent_id": 0,
"type_id": 349,
"user_id": 883,
"order_id": 94,
"location_id": 521,
"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": "Labadie, Skiles and Waters",
"serialnumber1": "SN586XU",
"serialnumber2": null,
"service_tag": "ST939LK",
"comments": null,
"label": "facere",
"description": "Qui eveniet ut quae qui nihil.",
"ip_addresses": [],
"purchase_date": "2025-04-21",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"metadata": [],
"device_traffic": null,
"type": {
"id": 349,
"name": "esse",
"description": "Accusamus necessitatibus ipsum et nesciunt alias a.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "fuchsia",
"created_at": "2026-04-21 13:17:06",
"updated_at": "2026-04-21 13:17:06"
},
"model": {
"id": 446,
"name": "iste",
"label": null,
"type_id": 349,
"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-04-21T11:17:08.000000Z",
"updated_at": "2026-04-21T11:17:08.000000Z"
},
"user": {
"id": 883,
"username": "chanel.reinger",
"email": "[email protected]",
"name": "Daisha Daugherty",
"firstname": "Daisha",
"lastname": "Daugherty",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/f1386bdf537f582fda7cfc3b869623ba?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/f1386bdf537f582fda7cfc3b869623ba?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": 521,
"app_id": null,
"name": "Howe, Murray and Bins",
"address": "79398 Reichert Avenue Suite 497\nLake Letitiaburgh, VT 14238",
"city": "Bradtkestad",
"state": "Colorado",
"description": "Veniam quae sequi fuga rem aut ab placeat. Et rem voluptatum qui vel. Pariatur harum consequatur ut excepturi. Nulla eius molestiae porro rem voluptate nulla.",
"notes": "Sunt quam cum in et dolorum distinctio fugit. Sed et fugiat sint nam harum. Sed nam tempore consequatur.",
"emergency": "0",
"phone": "+15759795078",
"flag": "Germany.png",
"created_at": "2026-04-21 13:17:07",
"updated_at": "2026-04-21 13:17:07"
},
"rack": null,
"parent": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Force Polling
requires authentication
Dispatches polling job for device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/1/poll" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/1/poll'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/1/poll';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Discover Device
requires authentication
Dispatches discovery job for device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/1/discover" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"protocol\": \"SNMP\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/1/discover'
payload = {
"protocol": "SNMP"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/1/discover';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'protocol' => 'SNMP',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Perform Power Action
requires authentication
Executes a power-related action on a device. This includes booting, rebooting, or shutting down the device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/123/power/action" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"action\": \"boot\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/123/power/action'
payload = {
"action": "boot"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/123/power/action';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'action' => 'boot',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Device Power Usage
requires authentication
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.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/101/power/usage" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"startDate\": \"2024-01-01 00:00:00\",
\"endDate\": \"2024-01-31 23:59:59\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/101/power/usage'
payload = {
"startDate": "2024-01-01 00:00:00",
"endDate": "2024-01-31 23:59:59"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/101/power/usage';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'startDate' => '2024-01-01 00:00:00',
'endDate' => '2024-01-31 23:59:59',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"AVG_TOTAL_USAGE": 10,
"units": "Amps"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Device Bandwidth
requires authentication
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.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/devices/101/bandwidth" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"startDate\": \"2024-01-01 00:00:00\",
\"endDate\": \"2024-01-31 23:59:59\",
\"units\": \"GB\",
\"ports\": [
12,
100
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/101/bandwidth'
payload = {
"startDate": "2024-01-01 00:00:00",
"endDate": "2024-01-31 23:59:59",
"units": "GB",
"ports": [
12,
100
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/101/bandwidth';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'startDate' => '2024-01-01 00:00:00',
'endDate' => '2024-01-31 23:59:59',
'units' => 'GB',
'ports' => [
12,
100,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Device
requires authentication
Removes the specified device from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/devices/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Graphs
Export Graph
requires authentication
Exports a graph data for a given target
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/graphs/42/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"AggregateTraffic\",
\"target\": \"service\",
\"start\": \"2025-04-01 00:00:00\",
\"end\": \"2025-04-30 23:59:59\",
\"raw\": false,
\"mode\": \"total\",
\"device_ids\": [
12
],
\"device_selection\": \"all\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/graphs/42/export'
payload = {
"type": "AggregateTraffic",
"target": "service",
"start": "2025-04-01 00:00:00",
"end": "2025-04-30 23:59:59",
"raw": false,
"mode": "total",
"device_ids": [
12
],
"device_selection": "all"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/graphs/42/export';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'AggregateTraffic',
'target' => 'service',
'start' => '2025-04-01 00:00:00',
'end' => '2025-04-30 23:59:59',
'raw' => false,
'mode' => 'total',
'device_ids' => [
12,
],
'device_selection' => 'all',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remote Agents
List Remote Agents
requires authentication
Returns a paginated list of Remote Agents (Remote Applications).
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 24,
"name": "sed ab voluptas",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
},
{
"id": 25,
"name": "ut ad minima",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Remote Agent
requires authentication
Display detailed information about a single Remote Agent by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/remote-agents/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 26,
"name": "deserunt aliquid repudiandae",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Remote Agent
requires authentication
Creates a new Remote Agent with the specified configuration.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/remote-agents" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"host\": \"192.168.56.100\",
\"apikey\": \"I4Vv1ZIgCXD6aykQF98kjuzG\",
\"name\": \"Remote Agent #1\",
\"pxe_ip\": \"192.168.56.101\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents'
payload = {
"host": "192.168.56.100",
"apikey": "I4Vv1ZIgCXD6aykQF98kjuzG",
"name": "Remote Agent #1",
"pxe_ip": "192.168.56.101"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'host' => '192.168.56.100',
'apikey' => 'I4Vv1ZIgCXD6aykQF98kjuzG',
'name' => 'Remote Agent #1',
'pxe_ip' => '192.168.56.101',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 27,
"name": "facilis voluptatem beatae",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Remote Agent
requires authentication
Removes the specified Remote Agent from the system.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/remote-agents/5" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/5'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/5';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List DHCP Subnets
requires authentication
Returns a paginated list of DHCP subnets assigned to the given Remote Agent.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/remote-agents/1/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/1/subnets'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/1/subnets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 10,
"type": "ipv4",
"subnet": "241.134.73.113",
"mask": 24,
"gateway": "197.197.120.144"
},
{
"id": 11,
"type": "ipv4",
"subnet": "23.71.9.59",
"mask": 24,
"gateway": "3.138.229.114"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create DHCP Subnet
requires authentication
Creates a new DHCP subnet for the specified Remote Agent.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/remote-agents/non/subnets" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"ipv4\",
\"subnet\": \"10.10.10.0\",
\"mask\": 24,
\"gateway\": \"10.10.10.1\",
\"description\": \"DHCP range for rack A\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/non/subnets'
payload = {
"type": "ipv4",
"subnet": "10.10.10.0",
"mask": 24,
"gateway": "10.10.10.1",
"description": "DHCP range for rack A"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/non/subnets';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'ipv4',
'subnet' => '10.10.10.0',
'mask' => 24.0,
'gateway' => '10.10.10.1',
'description' => 'DHCP range for rack A',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 12,
"type": "ipv4",
"subnet": "186.216.72.73",
"mask": 24,
"gateway": "11.103.0.132"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update DHCP Subnet
requires authentication
Updates an existing DHCP subnet configuration.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/deserunt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"ipv4\",
\"subnet\": \"10.10.10.0\",
\"mask\": 24,
\"gateway\": \"10.10.10.1\",
\"description\": \"DHCP range for rack A\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/deserunt'
payload = {
"type": "ipv4",
"subnet": "10.10.10.0",
"mask": 24,
"gateway": "10.10.10.1",
"description": "DHCP range for rack A"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/deserunt';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'ipv4',
'subnet' => '10.10.10.0',
'mask' => 24.0,
'gateway' => '10.10.10.1',
'description' => 'DHCP range for rack A',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 13,
"type": "ipv4",
"subnet": "246.156.99.48",
"mask": 24,
"gateway": "251.1.71.33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete DHCP Subnet
requires authentication
Deletes a DHCP subnet assigned to a Remote Agent.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/remote-agents/eos/subnets/assumenda" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/eos/subnets/assumenda'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/eos/subnets/assumenda';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OS Installation
List ISO Images
requires authentication
Returns a paginated list of ISO images
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/isoimages'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/isoimages';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 5,
"name": "quas-iso",
"iso_url": "https://www.stracke.net/qui-quae-sunt-enim-quo-voluptates",
"status": 3,
"status_label": "Finished",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
},
{
"id": 6,
"name": "quas-iso",
"iso_url": "http://www.rowe.com/eaque-ea-eaque-consequatur-aut-facilis-consequatur-eum.html",
"status": 3,
"status_label": "Finished",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show ISO Image
requires authentication
Returns detailed information about a specific ISO Image.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/isoimages/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 7,
"name": "quia-iso",
"iso_url": "http://pollich.com/",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create ISO Image
requires authentication
Creates a new ISO image.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/isoimages" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Ubuntu Server ISO\",
\"iso_url\": \"https:\\/\\/example.com\\/images\\/ubuntu.iso\",
\"remoteApp\": [
1
],
\"availability\": \"public\",
\"users\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/isoimages'
payload = {
"name": "Ubuntu Server ISO",
"iso_url": "https:\/\/example.com\/images\/ubuntu.iso",
"remoteApp": [
1
],
"availability": "public",
"users": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/isoimages';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Ubuntu Server ISO',
'iso_url' => 'https://example.com/images/ubuntu.iso',
'remoteApp' => [
1,
],
'availability' => 'public',
'users' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 8,
"name": "et-iso",
"iso_url": "http://metz.com/sunt-architecto-ipsam-repudiandae-id-quia-quidem-ratione-quasi",
"status": 4,
"status_label": "Error",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update ISO Image
requires authentication
Updates the name of an existing ISO image.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/os/isoimages/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Ubuntu Server ISO\",
\"remoteApp\": [
1
],
\"availability\": \"public\",
\"users\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/3'
payload = {
"name": "Ubuntu Server ISO",
"remoteApp": [
1
],
"availability": "public",
"users": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/3';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Ubuntu Server ISO',
'remoteApp' => [
1,
],
'availability' => 'public',
'users' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 9,
"name": "molestiae-iso",
"iso_url": "http://www.bahringer.net/dolorem-id-saepe-consequuntur-aut-qui",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete ISO Image
requires authentication
Deletes a specific ISO image.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/os/isoimages/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/3'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/isoimages/3';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List OS Templates
requires authentication
Returns a paginated list of OS templates.
Optionally, you can include a list of addons (based on template tags) by using the with_addons query parameter.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/templates'
params = {
'with_addons': '1',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_addons' => '1',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 50,
"template_id": 50,
"name": "eveniet",
"server_id": 17,
"tags": [
"eligendi",
"qui",
"qui"
],
"architecture": "arm",
"cache_folder": "quibusdam",
"mirror": "http://lubowitz.com/totam-facere-eum-rerum-et",
"edition": "accusantium",
"iso_url": "http://dare.net/fuga-modi-ipsam-minima-minima-laborum-rerum.html",
"tftp_url": "https://ziemann.net/vel-necessitatibus-consequatur-rerum-et-vel-tempore.html",
"license": "est",
"gpxe": "Dolores tempora aliquid soluta et quam iusto iste.",
"disk_layout": "Nostrum amet quia doloribus atque modi in.",
"packages": "Voluptas ducimus fugiat occaecati enim aliquid quis.",
"post_installation": "Qui architecto ab illo.",
"first_boot": "Culpa est rerum iste aut.",
"extras": "Omnis doloribus numquam ut magni.",
"timezone": "America/Mazatlan",
"language": "kj",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 17,
"app_id": 64,
"name": "Dr. Sarah Lebsack",
"module": "Remote Module",
"configuration": {
"app": 64,
"rebootmethod": "ipmi_easy_uefi",
"nameserver_1": "19.79.124.211",
"nameserver_2": "39.156.36.166",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 1
},
{
"id": 18,
"app_id": 65,
"name": "Eddie Gerlach",
"module": "Remote Module",
"configuration": {
"app": 65,
"rebootmethod": "ipmi_easy",
"nameserver_1": "163.193.35.144",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
}
]
},
{
"id": 51,
"template_id": 51,
"name": "autem",
"server_id": 19,
"tags": [
"repudiandae",
"rem",
"id",
"enim",
"quibusdam"
],
"architecture": "arm",
"cache_folder": "delectus",
"mirror": "http://crist.com/ipsa-sint-repellat-quis",
"edition": "totam",
"iso_url": "http://rosenbaum.com/ut-labore-quod-magni-et-odit-eius",
"tftp_url": "http://harber.biz/enim-deserunt-maxime-quae-cum-debitis-quia",
"license": "et",
"gpxe": "Nesciunt natus doloribus quia rerum officia voluptas id.",
"disk_layout": "Et aut quo velit.",
"packages": "Nisi ut itaque suscipit nesciunt.",
"post_installation": "Accusantium est eum distinctio ipsam.",
"first_boot": "Voluptatibus quos dicta eligendi repellat eius expedita laborum.",
"extras": "Numquam repudiandae ex rerum dolores sequi.",
"timezone": "Africa/Gaborone",
"language": "kv",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 19,
"app_id": 66,
"name": "Valentin Schultz",
"module": "Remote Module",
"configuration": {
"app": 66,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 0
},
{
"id": 20,
"app_id": 67,
"name": "Dr. Lavonne Cremin V",
"module": "Remote Module",
"configuration": {
"app": 67,
"rebootmethod": "ipmi_easy_uefi",
"nameserver_1": "117.253.104.217",
"nameserver_2": "180.141.44.163",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
}
]
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show OS Template
requires authentication
Returns detailed information about a specific template.
Optionally, you can include a list of addons (based on template tags) by using the with_addons query parameter.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/templates/1?with_addons=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/templates/1'
params = {
'with_addons': '1',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_addons' => '1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 52,
"template_id": 52,
"name": "dolorem",
"server_id": 21,
"tags": [
"est",
"et",
"optio",
"sapiente"
],
"architecture": "arm",
"cache_folder": "qui",
"mirror": "https://donnelly.info/at-quidem-eum-temporibus-sit-sint-veritatis.html",
"edition": "recusandae",
"iso_url": "http://hand.com/nulla-perspiciatis-quia-facilis-dolores",
"tftp_url": "http://friesen.com/sed-assumenda-eligendi-quia-est-expedita",
"license": "consequatur",
"gpxe": "Reiciendis sint dolor animi eos.",
"disk_layout": "Magnam eveniet distinctio et porro adipisci iste.",
"packages": "Porro enim aliquid velit fuga alias non consectetur.",
"post_installation": "Alias porro fugit non voluptatum non delectus alias suscipit.",
"first_boot": "Doloremque alias ut nemo.",
"extras": "Temporibus hic cum unde ut rerum est quidem.",
"timezone": "Asia/Almaty",
"language": "nv",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 21,
"app_id": 68,
"name": "Gardner Bogan",
"module": "Remote Module",
"configuration": {
"app": 68,
"rebootmethod": "ipmi_easy",
"nameserver_1": "113.124.9.39",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 1
},
{
"id": 22,
"app_id": 69,
"name": "Rory Barton",
"module": "Remote Module",
"configuration": {
"app": 69,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "43.153.119.229",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 1
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create OS Template
requires authentication
Creates a new template with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/templates" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/templates'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 53,
"template_id": 53,
"name": "voluptate",
"server_id": 23,
"tags": [
"odit",
"in",
"dolorum",
"eaque",
"ducimus",
"sequi"
],
"architecture": "x64",
"cache_folder": "voluptatum",
"mirror": "http://www.zulauf.com/quisquam-repellendus-ut-voluptas",
"edition": "cumque",
"iso_url": "http://www.hilpert.com/molestiae-atque-qui-et-numquam-architecto",
"tftp_url": "http://www.ritchie.net/",
"license": "deserunt",
"gpxe": "Debitis ut doloremque facere voluptas.",
"disk_layout": "Doloremque qui ipsam voluptas possimus consequatur nemo.",
"packages": "Quis possimus amet voluptas quia.",
"post_installation": "Sunt reiciendis illo debitis voluptas ullam et aut occaecati.",
"first_boot": "Mollitia provident consequatur ullam dignissimos.",
"extras": "Vel eveniet pariatur cum officiis.",
"timezone": "America/Bogota",
"language": "sm",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 23,
"app_id": 70,
"name": "Hassan Gerlach",
"module": "Remote Module",
"configuration": {
"app": 70,
"rebootmethod": "pdu",
"nameserver_1": "185.230.52.11",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 1
},
{
"id": 24,
"app_id": 71,
"name": "Prof. Nedra Doyle",
"module": "Remote Module",
"configuration": {
"app": 71,
"rebootmethod": "ipmi_easy",
"nameserver_1": null,
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "vmware.kpxe"
},
"enabled": 1
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update OS Template
requires authentication
Updates template with the provided details and id.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/os/templates/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/templates/1'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 54,
"template_id": 54,
"name": "tempore",
"server_id": 25,
"tags": [
"laudantium",
"totam",
"provident",
"eveniet",
"qui"
],
"architecture": "arm",
"cache_folder": "vel",
"mirror": "http://www.rolfson.com/hic-qui-minima-tempora-aut-et-porro-consectetur-aliquid.html",
"edition": "quia",
"iso_url": "http://abernathy.info/ut-officia-saepe-quidem-ipsum-dolorem.html",
"tftp_url": "http://www.hand.com/dolorem-consequatur-voluptatum-dolore",
"license": "voluptatem",
"gpxe": "Quos velit et occaecati aut.",
"disk_layout": "Dolores laborum qui voluptas rem earum quisquam.",
"packages": "Voluptatem dicta illum sunt dolore libero.",
"post_installation": "Et tenetur quasi quia neque in.",
"first_boot": "Non et dolores laboriosam non natus.",
"extras": "Doloribus velit quis harum vero quaerat.",
"timezone": "America/El_Salvador",
"language": "ak",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 25,
"app_id": 72,
"name": "Ms. Greta Wehner IV",
"module": "Remote Module",
"configuration": {
"app": 72,
"rebootmethod": "ipmi_easy",
"nameserver_1": null,
"nameserver_2": "40.40.241.233",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
},
{
"id": 26,
"app_id": 73,
"name": "Dr. Lucienne Marquardt",
"module": "Remote Module",
"configuration": {
"app": 73,
"rebootmethod": "manual",
"nameserver_1": "167.134.57.233",
"nameserver_2": "46.230.199.232",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete OS Template
requires authentication
Deletes template with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/os/templates/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/templates/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List OS Addons
requires authentication
Returns a paginated list of OS addons.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/addons?template_id=17&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/addons'
params = {
'template_id': '17',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/addons';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'template_id' => '17',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 16,
"server_id": 27,
"name": "Dr. Phoebe McClure",
"description": "Sunt incidunt ducimus consequatur voluptatem cumque sequi repellat.",
"type": "postinstall",
"tag": "debitis assumenda",
"tags": [
"debitis",
"assumenda"
],
"data": "Praesentium sed vel ipsam placeat cupiditate vel et."
},
{
"id": 17,
"server_id": 28,
"name": "Alysha O'Conner IV",
"description": "Non atque voluptatem est deleniti velit doloribus.",
"type": "firstboot",
"tag": "sit vel",
"tags": [
"sit",
"vel"
],
"data": "Ut voluptatem quia temporibus dolores velit."
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show OS Addon
requires authentication
Returns detailed information about a specific addon.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/addons/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/addons/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/addons/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"id": 18,
"server_id": 29,
"name": "Maybelle Kulas",
"description": "Dolorem reprehenderit dolor vel temporibus.",
"type": "postinstall",
"tag": "doloribus distinctio",
"tags": [
"doloribus",
"distinctio"
],
"data": "Quasi quidem enim qui repudiandae."
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create OS Addon
requires authentication
Creates a new addon with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/addons" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"cpanel\",
\"tag\": \"laudantium\",
\"type\": \"disklayout\",
\"description\": \"Install cPanel\",
\"data\": \"Example addon script\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/addons'
payload = {
"name": "cpanel",
"tag": "laudantium",
"type": "disklayout",
"description": "Install cPanel",
"data": "Example addon script"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/addons';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'cpanel',
'tag' => 'laudantium',
'type' => 'disklayout',
'description' => 'Install cPanel',
'data' => 'Example addon script',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"id": 19,
"server_id": 30,
"name": "Dr. Elissa Hane Jr.",
"description": "Fugit voluptates cupiditate sapiente soluta ut amet.",
"type": "disklayout",
"tag": "ut id",
"tags": [
"ut",
"id"
],
"data": "Perspiciatis dolores et alias consequatur dolore quisquam amet omnis."
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update OS Addon
requires authentication
Updates addon with the provided details and id.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/os/addons/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"cpanel\",
\"tag\": \"iusto\",
\"type\": \"disklayout\",
\"description\": \"Install cPanel\",
\"data\": \"Example addon script\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/addons/1'
payload = {
"name": "cpanel",
"tag": "iusto",
"type": "disklayout",
"description": "Install cPanel",
"data": "Example addon script"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/addons/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'cpanel',
'tag' => 'iusto',
'type' => 'disklayout',
'description' => 'Install cPanel',
'data' => 'Example addon script',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"id": 20,
"server_id": 31,
"name": "Dr. Mercedes Marvin PhD",
"description": "Dolores esse nihil et excepturi doloremque.",
"type": "disklayout",
"tag": "ipsa cumque",
"tags": [
"ipsa",
"cumque"
],
"data": "Eum esse aut vel nostrum voluptas fuga et."
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete OS Addon
requires authentication
Deletes addon with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/os/addons/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/addons/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/addons/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Install OS on Device
requires authentication
Initiates OS installation on a device
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/1/install" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template\": 12,
\"hostname\": \"server01.example.com\",
\"username\": \"admin\",
\"password\": \"secret123\",
\"root_password\": \"rootsecret\",
\"disk_addon\": 1,
\"extras\": [
14
],
\"ssh_keys\": [
4
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/install'
payload = {
"template": 12,
"hostname": "server01.example.com",
"username": "admin",
"password": "secret123",
"root_password": "rootsecret",
"disk_addon": 1,
"extras": [
14
],
"ssh_keys": [
4
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/install';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'template' => 12,
'hostname' => 'server01.example.com',
'username' => 'admin',
'password' => 'secret123',
'root_password' => 'rootsecret',
'disk_addon' => 1,
'extras' => [
14,
],
'ssh_keys' => [
4,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 12,
"device_id": 385,
"template_id": 55,
"server_id": 32,
"message": "Ea sit pariatur quia hic exercitationem et.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-04-21 13:17:10",
"updated_at": "2026-04-21 13:17:10"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Cancel OS Installation
requires authentication
Attempts to cancel the operating system installation process
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/1/cancel" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/cancel'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/cancel';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OS Installation Information
requires authentication
Returns details about the current OS installation process
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/1/install/information" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/install/information'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/install/information';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 13,
"device_id": 386,
"template_id": 56,
"server_id": 35,
"message": "Harum repudiandae temporibus molestiae atque sit voluptate.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-04-21 13:17:10",
"updated_at": "2026-04-21 13:17:10"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Enable Rescue Mode
requires authentication
Initiates rescue mode for the device
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/1/rescue/enable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/rescue/enable'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/rescue/enable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 14,
"device_id": 387,
"template_id": 57,
"server_id": 38,
"message": "Excepturi repudiandae at aut placeat sint velit.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-04-21 13:17:10",
"updated_at": "2026-04-21 13:17:10"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Rescue Mode Status
requires authentication
Returns the current rescue mode status
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/1/rescue/status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/rescue/status'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/rescue/status';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"inRescueMode": false
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Device Configuration
requires authentication
Returns device OS configuration.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/1/configuration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Device Configuration
requires authentication
Updates device OS configuration with the provided details and id.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/1/configuration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration'
payload = {
"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"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Find OS provisioning server
requires authentication
Returns detailed information about provisioning server
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/1/provisioning/server?find_by_type=device" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/1/provisioning/server'
params = {
'find_by_type': 'device',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/provisioning/server';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'find_by_type' => 'device',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 41,
"app_id": 88,
"name": "Mrs. Demetris Windler",
"module": "Remote Module",
"configuration": {
"app": 88,
"rebootmethod": "ipmi_easy",
"nameserver_1": "136.109.63.189",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "vmware.kpxe"
},
"enabled": 1
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List provisioning tasks
requires authentication
Returns a paginated list of provisioning tasks.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/tasks'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/tasks';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 15,
"device_id": 388,
"template_id": 58,
"server_id": 42,
"message": "Harum in ab repellendus sunt illum.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-04-21 13:17:11",
"updated_at": "2026-04-21 13:17:11"
},
{
"id": 16,
"device_id": 389,
"template_id": 59,
"server_id": 45,
"message": "Animi omnis dolores consequuntur qui dolores odit architecto.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-04-21 13:17:11",
"updated_at": "2026-04-21 13:17:11"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List provisioning history
requires authentication
Returns a paginated list of provisioning history.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/history'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/history';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 9,
"device_id": 390,
"server_id": 48,
"template": "Ms. Clemmie Okuneva",
"status": "",
"log": "",
"created_at": "2026-04-21 13:17:11",
"updated_at": "2026-04-21 13:17:11"
},
{
"id": 10,
"device_id": 391,
"server_id": 49,
"template": "Abner Powlowski",
"status": "",
"log": "",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Provisioning Profiles
requires authentication
Returns a paginated list of provisioning profiles.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles'
params = {
'search_term': 'active,pending',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'search_term' => 'active,pending',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 22,
"uuid": "96e05e22-5ce0-3c4b-82a9-7d1e0c0ed1b4",
"name": "Startnet repellendus",
"description": "Dolor perferendis eius et voluptatem atque perspiciatis distinctio.",
"type": {
"value": "startnet",
"label": "Startnet (Windows)"
},
"version": "2.0",
"predefined": true,
"official": true,
"installation_template": "startnet_earum",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
},
{
"id": 23,
"uuid": "311ff4f4-8e6f-34aa-8dd3-0f04dcd88695",
"name": "Preseed inventore",
"description": "Qui illum minima ut quaerat velit dolorem.",
"type": {
"value": "preseed",
"label": "Preseed (Debian/Ubuntu legacy)"
},
"version": "1.1",
"predefined": false,
"official": false,
"installation_template": "preseed_eligendi",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Provisioning Profile
requires authentication
Returns detailed information about a specific provisioning profile.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 24,
"uuid": "ebf45948-6b88-30f6-8c5d-333c66fccd50",
"name": "Firstboot provident",
"description": "Non rerum soluta aut.",
"type": {
"value": "firstboot",
"label": "FirstBoot (Bootstrap script)"
},
"version": "1.0",
"predefined": false,
"official": false,
"installation_template": "firstboot_cumque",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Provisioning Profile
requires authentication
Creates a new provisioning profile.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/os/provisioning-profiles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Basic Kickstart\",
\"description\": \"Default kickstart profile for Linux installations.\",
\"type\": \"kickstart\",
\"version\": \"1.0\",
\"installation_template\": \"firstboot_linux_ssh_network\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles'
payload = {
"name": "Basic Kickstart",
"description": "Default kickstart profile for Linux installations.",
"type": "kickstart",
"version": "1.0",
"installation_template": "firstboot_linux_ssh_network"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Basic Kickstart',
'description' => 'Default kickstart profile for Linux installations.',
'type' => 'kickstart',
'version' => '1.0',
'installation_template' => 'firstboot_linux_ssh_network',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 25,
"uuid": "be6a89ab-1594-359b-9ff7-851ec6f56fca",
"name": "Startnet id",
"description": "Voluptas perspiciatis facere vitae in ad quia consequatur.",
"type": {
"value": "startnet",
"label": "Startnet (Windows)"
},
"version": "2.0",
"predefined": false,
"official": false,
"installation_template": "startnet_officia",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Provisioning Profile
requires authentication
Updates provisioning profile with the provided details.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Basic Kickstart\",
\"description\": \"Updated description.\",
\"type\": \"kickstart\",
\"version\": \"1.1\",
\"installation_template\": \"firstboot_linux_ssh_network\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1'
payload = {
"name": "Basic Kickstart",
"description": "Updated description.",
"type": "kickstart",
"version": "1.1",
"installation_template": "firstboot_linux_ssh_network"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Basic Kickstart',
'description' => 'Updated description.',
'type' => 'kickstart',
'version' => '1.1',
'installation_template' => 'firstboot_linux_ssh_network',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Provisioning Profile
requires authentication
Deletes provisioning profile with given id.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning-profiles/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.IPMI
List Proxy Servers
requires authentication
Returns a paginated list of proxy servers.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers'
params = {
'with_sessions': '1',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_sessions' => '1',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 3,
"app_id": 98,
"name": "Franco Collins",
"locations": [
{
"id": 570,
"app_id": null,
"name": "Ferry Group",
"address": "23466 Jarrett Course Suite 492\nShieldsville, MT 97278",
"city": "Mrazton",
"state": "New York",
"description": "Possimus quidem ea voluptatem quaerat molestias et. Explicabo rerum provident qui totam voluptas. Quis porro quod quis et et dolor in. Rerum rerum dolorem non iure voluptatem mollitia. Illo quo dolores minus voluptatum.",
"notes": "Pariatur necessitatibus nulla sit ipsa aspernatur. Voluptas itaque debitis non neque nisi aliquam nihil. Quasi neque dolores et corrupti necessitatibus aut quia.",
"emergency": "0",
"phone": "779.807.4822",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
},
{
"id": 571,
"app_id": null,
"name": "Rice PLC",
"address": "400 Marietta Plains Suite 189\nNew Zanemouth, PA 67080",
"city": "Vonfurt",
"state": "Delaware",
"description": "Doloribus unde iure quaerat voluptate ut tenetur sed et. Amet enim odit beatae sint maxime quos esse dicta. Id expedita illo sit modi ut nisi.",
"notes": "Placeat iusto odit provident ut. Libero mollitia et quod adipisci eligendi. Est at deserunt quasi. Eos deleniti magnam qui ea et vel necessitatibus.",
"emergency": "0",
"phone": "(276) 907-6187",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"configuration": []
},
{
"id": 4,
"app_id": 99,
"name": "Vada Vandervort DVM",
"locations": [
{
"id": 572,
"app_id": null,
"name": "Thiel, Klein and Swift",
"address": "48529 Selmer Crescent\nWolffhaven, AR 99197-1261",
"city": "Schusterburgh",
"state": "Pennsylvania",
"description": "Aut nulla dolorem impedit provident est et possimus. Officiis explicabo sapiente ea in.",
"notes": "Eum ex quo velit et ut repellendus. Excepturi impedit distinctio eum et nulla accusantium. Molestiae officiis rerum ipsam dolor. Et veritatis aut debitis natus.",
"emergency": "0",
"phone": "1-534-964-6253",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
},
{
"id": 573,
"app_id": null,
"name": "Keebler Ltd",
"address": "337 Lesley Squares\nSouth Dinostad, NC 97720",
"city": "New Casimerborough",
"state": "Virginia",
"description": "Qui culpa assumenda placeat ad recusandae cum quaerat. Officia sint consequatur eligendi omnis sint omnis nisi. Nostrum ut omnis porro sunt. Error qui quidem et quis.",
"notes": "Eaque sit explicabo voluptates dolor animi neque. Qui eum ea a molestiae in est quod. Harum expedita doloribus ad omnis qui sapiente.",
"emergency": "0",
"phone": "(715) 685-5217",
"flag": "USA.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Proxy Server
requires authentication
Returns detailed information about a specific proxy server.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1?with_sessions=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1'
params = {
'with_sessions': '1',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_sessions' => '1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 5,
"app_id": 100,
"name": "Ms. Stacey Toy Sr.",
"locations": [
{
"id": 574,
"app_id": null,
"name": "Bogan PLC",
"address": "28878 Walter Junction Apt. 283\nWest Mariamshire, MA 04220",
"city": "East Ivah",
"state": "California",
"description": "Quia sit reprehenderit et repudiandae eaque hic ipsa illum. Quasi veritatis voluptas quas libero ipsa.",
"notes": "Id eligendi eaque hic dignissimos. Qui molestiae sed nostrum ut. Veritatis debitis blanditiis quisquam optio porro omnis repudiandae.",
"emergency": "1",
"phone": "1-512-714-3072",
"flag": "USA.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
},
{
"id": 575,
"app_id": null,
"name": "D'Amore, Willms and Bailey",
"address": "8380 Sonia Fields Apt. 108\nNorth Joanie, IL 67944",
"city": "West Otto",
"state": "New Mexico",
"description": "Ratione adipisci aut aut ut consectetur. Quidem quibusdam itaque et ad. Fuga doloribus rerum corrupti officia saepe pariatur et. Nulla beatae voluptatibus saepe ad consequatur ab illo.",
"notes": "Ipsa adipisci eum iusto est nisi. Aliquid autem praesentium quia sunt. Autem quis aperiam qui ut ea. Dolor minus aliquid nobis numquam. Incidunt ut qui rerum eum et totam.",
"emergency": "0",
"phone": "1-207-714-4584",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"configuration": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Proxy Server
requires authentication
Creates a new proxy server with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Main IPMI Proxy\",
\"app_id\": 12,
\"location\": [
9
],
\"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
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers'
payload = {
"name": "Main IPMI Proxy",
"app_id": 12,
"location": [
9
],
"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
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Main IPMI Proxy',
'app_id' => 12,
'location' => [
9,
],
'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,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 6,
"app_id": 101,
"name": "Marley Smith",
"locations": [
{
"id": 576,
"app_id": null,
"name": "Rolfson-Marks",
"address": "20470 Tyson Walks\nBergeberg, TX 00688",
"city": "Pouroshaven",
"state": "Ohio",
"description": "Esse labore libero cum asperiores quia. Eum sunt minima sed et et. Saepe est fugiat cumque.",
"notes": "Distinctio ut et tempore enim non saepe ratione. Atque nemo perferendis quis dolores molestiae. Laborum dicta dolores est qui tenetur perspiciatis facilis.",
"emergency": "0",
"phone": "+14253616895",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
},
{
"id": 577,
"app_id": null,
"name": "Labadie, Schimmel and Harvey",
"address": "1317 Maggio Place Apt. 322\nEast Alysafort, NJ 01797",
"city": "Erynhaven",
"state": "Alabama",
"description": "Voluptas sed cum qui reiciendis accusamus impedit. Quia voluptatem molestiae vero autem molestiae non. Reiciendis eum aut quo magnam dicta dolor.",
"notes": "Sint labore placeat eveniet alias. Eveniet molestias atque sint occaecati magni. Molestias aspernatur aperiam enim ex laboriosam enim provident. Non quia pariatur sapiente quisquam.",
"emergency": "0",
"phone": "1-570-385-0821",
"flag": "Canada.png",
"created_at": "2026-04-21 13:17:12",
"updated_at": "2026-04-21 13:17:12"
}
],
"configuration": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Proxy Server
requires authentication
Updates proxy server with the provided details and id.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Main IPMI Proxy\",
\"app_id\": 12,
\"location\": [
10
],
\"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
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1'
payload = {
"name": "Main IPMI Proxy",
"app_id": 12,
"location": [
10
],
"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
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Main IPMI Proxy',
'app_id' => 12,
'location' => [
10,
],
'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,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 7,
"app_id": 102,
"name": "Gerardo Beahan IV",
"locations": [
{
"id": 578,
"app_id": null,
"name": "Grady, Bailey and Douglas",
"address": "748 Chaya Underpass\nHintzbury, KY 39709-9903",
"city": "Mayton",
"state": "Wisconsin",
"description": "Eligendi natus est sit nihil eos consequuntur molestias cumque. Sed at sit ex aut. Optio quis sapiente non architecto temporibus velit. Suscipit deserunt fugit officiis similique vero. Beatae temporibus rerum porro voluptatum fugiat.",
"notes": "Ducimus ipsa eaque quis nulla error. Asperiores iure qui quia placeat dolores. Culpa est cupiditate et fugiat culpa qui atque.",
"emergency": "0",
"phone": "513-551-1704",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:13",
"updated_at": "2026-04-21 13:17:13"
},
{
"id": 579,
"app_id": null,
"name": "Kulas Inc",
"address": "4935 Aurelie Ferry Suite 398\nSouth Judy, VA 46883-9840",
"city": "Feeneymouth",
"state": "West Virginia",
"description": "Est et mollitia facere. Itaque quibusdam et voluptate.",
"notes": "Officia sint magnam similique laudantium suscipit neque porro natus. Voluptates fuga et tempora. Molestiae est amet praesentium facere.",
"emergency": "1",
"phone": "1-213-244-0105",
"flag": "UK.png",
"created_at": "2026-04-21 13:17:13",
"updated_at": "2026-04-21 13:17:13"
}
],
"configuration": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Proxy Server
requires authentication
Deletes proxy server with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Proxy Sessions
requires authentication
Returns a paginated list of proxy sessions.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 7,
"device_id": 393,
"ipmi_proxy_id": 8,
"url": "https://192.168.203.150/client/console/50548/88ES2NDb/6fb0ce09e47455150c33b31c55a7f63117fbd4e2",
"status": 1,
"message": "Ea sit quia sit placeat necessitatibus voluptatem molestiae.",
"log": null
},
{
"id": 8,
"device_id": 394,
"ipmi_proxy_id": 9,
"url": "https://192.168.203.150/client/console/17372/rRSs5kpV/103562cbaf0cca436f60e4dd662414181ce0e0ad",
"status": 1,
"message": "Expedita voluptas qui error voluptas.",
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Proxy Session
requires authentication
Returns detailed information about a specific proxy session.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 9,
"device_id": 395,
"ipmi_proxy_id": 10,
"url": "https://192.168.203.150/client/console/8382/s1GdjbzF/f13a62fb70a96ab28817b582f4aeb4d3e76f5eeb",
"status": 1,
"message": "Quidem enim doloremque provident quia voluptatem fugiat est.",
"log": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Proxy Session
requires authentication
Deletes proxy session with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/sessions/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Start noVNC Session
requires authentication
Initiates a remote IPMI proxy session to the BMC of the device. The proxy allows web-based access to the BMC for remote management tasks like KVM, virtual media, or BIOS configuration.
If a session cannot be established, an error with logs may be returned for debugging purposes.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipmi/1/novnc-connect" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/novnc-connect'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/novnc-connect';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 10,
"device_id": 396,
"ipmi_proxy_id": 11,
"url": "https://192.168.203.150/client/console/47590/FZZZisuX/1cd433a0fd095297412d2254cde497ba9671c185",
"status": 1,
"message": "Ullam id rerum ut rem eaque.",
"log": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.IPMI Power Status
requires authentication
Checking IPMI power status of the device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipmi/1/power-status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/power-status'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/power-status';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"status": "running"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.BMC Cold Reset
requires authentication
Sends a cold reset command to the BMC (Baseboard Management Controller) of the device. This action forces a full reboot of the BMC, which may temporarily interrupt device management features.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipmi/1/bmc-reset-cold" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/bmc-reset-cold'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/bmc-reset-cold';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.IP Address Management
List of Subnets
requires authentication
Returns a paginated list of subnets
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'mask',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'mask',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 6,
"pool": "251.23.216.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Et maxime dolorem atque dolores quis eum deleniti.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
},
{
"id": 7,
"pool": "195.9.99.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Architecto magnam adipisci consequatur dolore consequuntur id et dolores.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Subnet
requires authentication
Returns detailed information about a specific subnet.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipam/subnets/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 8,
"pool": "4.153.37.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Est quidem modi in aut sed.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "4.153.37.1",
"end": "4.153.37.254"
}
]
},
"addressing": {
"network_address": "4.153.37.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "4.153.37.255",
"first_available_ip": "4.153.37.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Subnet
requires authentication
Creates a new subnet with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipam/subnets" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets'
payload = {
"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"
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 9,
"pool": "95.174.118.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Ea et iure nesciunt non ut.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "95.174.118.1",
"end": "95.174.118.254"
}
]
},
"addressing": {
"network_address": "95.174.118.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "95.174.118.255",
"first_available_ip": "95.174.118.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Subnet
requires authentication
Updates subnet with the provided details and id.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/ipam/subnets/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1'
payload = {
"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"
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 10,
"pool": "194.215.238.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Ipsam dolore at voluptas mollitia voluptatem temporibus aut ut.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "194.215.238.1",
"end": "194.215.238.254"
}
]
},
"addressing": {
"network_address": "194.215.238.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "194.215.238.255",
"first_available_ip": "194.215.238.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Split Subnet
requires authentication
Splits subnet with given id.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipam/subnets/1/split" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"selected_mask\": 32
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1/split'
payload = {
"selected_mask": 32
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1/split';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'selected_mask' => 32,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 11,
"pool": "161.105.4.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Iusto voluptas facilis et iure totam veritatis.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "161.105.4.1",
"end": "161.105.4.254"
}
]
},
"addressing": {
"network_address": "161.105.4.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "161.105.4.255",
"first_available_ip": "161.105.4.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Subnet
requires authentication
Deletes subnet with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/ipam/subnets/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List User Subnets
requires authentication
Returns a paginated list of subnets for user
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipam/user/1/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=mask" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/user/1/subnets'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'mask',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/user/1/subnets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'mask',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 12,
"pool": "23.163.12.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Corrupti deleniti recusandae aliquam consequuntur.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
},
{
"id": 13,
"pool": "200.207.240.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Placeat nemo nihil quae hic quis enim.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Device Subnets
requires authentication
Returns a paginated list of subnets for device
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=mask" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'mask',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'mask',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 14,
"pool": "102.255.62.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Illum voluptas provident aut nihil voluptatem voluptates.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
},
{
"id": 15,
"pool": "144.145.250.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Ducimus quia cum veniam exercitationem.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-04-21 13:17:14",
"updated_at": "2026-04-21 13:17:14"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign Subnets to Device
requires authentication
Assigns Subnets to Device
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"subnets\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/assign'
payload = {
"subnets": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/assign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'subnets' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 397,
"label": "adipisci",
"model": "quae",
"product_id": 0,
"model_id": 462,
"parent_id": 0,
"type_id": 381,
"user_id": 1021,
"order_id": 110,
"location_id": 605,
"rack_id": 189,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Blanda-Homenick",
"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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null,
"subnets": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unassign Subnets to Device
requires authentication
Unassigns Subnets to Device
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/unassign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"subnets\": [
1
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/unassign'
payload = {
"subnets": [
1
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/device/1/subnets/unassign';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'subnets' => [
1,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 398,
"label": "corporis",
"model": "alias",
"product_id": 0,
"model_id": 463,
"parent_id": 0,
"type_id": 383,
"user_id": 1028,
"order_id": 111,
"location_id": 609,
"rack_id": 190,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"device_status": "running",
"service_status": "activated",
"location": "Howell 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": "<span class=\"edc-badge edc-badge-muted\">Unassigned</span>",
"device_traffic": null,
"subnets": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List of IP addresses
requires authentication
This endpoint returns a paginated collection of IP addresses
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/ips'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'value',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/ips';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'value',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 265,
"item_id": 38,
"value": "200.94.209.231",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update IP address description
requires authentication
Updates the description of an IP address entity
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/ipam/ips/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"description\": \"Primary IP for web server\",
\"ip_address\": \"192.168.56.1\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/ips/456'
payload = {
"description": "Primary IP for web server",
"ip_address": "192.168.56.1"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/ips/456';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'description' => 'Primary IP for web server',
'ip_address' => '192.168.56.1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List of VLANs
requires authentication
This endpoint returns a paginated collection of VLANs
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'vlan_vlan',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'vlan_vlan',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 2,
"device_id": null,
"vlan_vlan": 2310,
"vlan_name": "quibusdam hic",
"description": "Aut quo est eveniet nulla assumenda nisi commodi minus.",
"vlan_type": "provisioning",
"vlan_status": "active",
"device": null
},
{
"id": 3,
"device_id": null,
"vlan_vlan": 2510,
"vlan_name": "quod assumenda",
"description": "Tenetur debitis minus eligendi in architecto molestiae ipsa omnis.",
"vlan_type": "provisioning",
"vlan_status": "reserved",
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show VLAN
requires authentication
Returns detailed information about a specific VLAN.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipam/vlans/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 4,
"device_id": null,
"vlan_vlan": 269,
"vlan_name": "maiores ut",
"description": "Unde tempore sint impedit minus ut voluptatem nesciunt cumque.",
"vlan_type": "standard",
"vlan_status": "depreciated",
"device": null,
"ports": []
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create VLAN
requires authentication
Creates a new vlan with the provided details.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipam/vlans" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"device_id\": 1,
\"vlan_vlan\": 1001,
\"vlan_name\": \"VLAN 1001\",
\"vlan_type\": \"standard\",
\"status\": \"active\",
\"description\": \"This is the description of the vlan.\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans'
payload = {
"device_id": 1,
"vlan_vlan": 1001,
"vlan_name": "VLAN 1001",
"vlan_type": "standard",
"status": "active",
"description": "This is the description of the vlan."
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'device_id' => 1,
'vlan_vlan' => 1001,
'vlan_name' => 'VLAN 1001',
'vlan_type' => 'standard',
'status' => 'active',
'description' => 'This is the description of the vlan.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 5,
"device_id": null,
"vlan_vlan": 1860,
"vlan_name": "dolores non",
"description": "Saepe amet animi odit facilis quia suscipit corporis magnam.",
"vlan_type": "standard",
"vlan_status": "active",
"device": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update VLAN
requires authentication
Updates vlan with the provided details and id.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/ipam/vlans/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"vlan_type\": \"standard\",
\"status\": \"active\",
\"description\": \"This is the description of the vlan.\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1'
payload = {
"vlan_type": "standard",
"status": "active",
"description": "This is the description of the vlan."
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'vlan_type' => 'standard',
'status' => 'active',
'description' => 'This is the description of the vlan.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 6,
"device_id": null,
"vlan_vlan": 2655,
"vlan_name": "aut ipsam",
"description": "Aut accusantium velit qui non.",
"vlan_type": "standard",
"vlan_status": "active",
"device": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete VLAN
requires authentication
Deletes vlan with given id
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/ipam/vlans/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/vlans/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.DNS Management
List rDNS records
requires authentication
This endpoint returns a paginated list of reverse DNS (rDNS) entries
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 3,
"device_id": 401,
"user_id": 1057,
"server_id": 3,
"ip": "214.239.117.161",
"from": "marvin.biz",
"name": "gutmann.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:16",
"updated_at": "2026-04-21 13:17:16"
},
{
"id": 4,
"device_id": 402,
"user_id": 1065,
"server_id": 4,
"ip": "57.42.25.56",
"from": "bogan.net",
"name": "stoltenberg.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:16",
"updated_at": "2026-04-21 13:17:16"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create rDNS record
requires authentication
Stores a new reverse DNS (rDNS) entry
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/dns-manager/rdns" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ip\": \"192.168.1.1\",
\"rdata\": \"example.mydomain.com\",
\"device_id\": 1,
\"ttl\": 3600
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns'
payload = {
"ip": "192.168.1.1",
"rdata": "example.mydomain.com",
"device_id": 1,
"ttl": 3600
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'ip' => '192.168.1.1',
'rdata' => 'example.mydomain.com',
'device_id' => 1,
'ttl' => 3600,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 5,
"device_id": 403,
"user_id": 1073,
"server_id": 5,
"ip": "85.252.219.2",
"from": "ratke.com",
"name": "kiehn.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:17",
"updated_at": "2026-04-21 13:17:17"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update rDNS record
requires authentication
Updates an existing reverse DNS (rDNS) record.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"rdata\": \"updated.example.net\",
\"ttl\": 3600
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456'
payload = {
"rdata": "updated.example.net",
"ttl": 3600
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'rdata' => 'updated.example.net',
'ttl' => 3600,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 6,
"device_id": 404,
"user_id": 1081,
"server_id": 6,
"ip": "67.161.234.126",
"from": "cartwright.com",
"name": "turner.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:17",
"updated_at": "2026-04-21 13:17:17"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete rDNS record
requires authentication
Deletes a reverse DNS (rDNS) record.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/rdns/456';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Zones
requires authentication
This endpoint returns a paginated list of zones
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 1,
"device_id": 405,
"server_id": 7,
"ip": "100.52.139.98",
"name": "mraz.com",
"created_at": "2026-04-21 13:17:17",
"updated_at": "2026-04-21 13:17:17"
},
{
"id": 2,
"device_id": 406,
"server_id": 8,
"ip": "120.221.45.3",
"name": "barton.com",
"created_at": "2026-04-21 13:17:18",
"updated_at": "2026-04-21 13:17:18"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Zone
requires authentication
Stores a new zone
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/dns-manager/zones" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ip\": \"192.168.1.1\",
\"name\": \"example.mydomain.com\",
\"device_id\": 1,
\"server_id\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones'
payload = {
"ip": "192.168.1.1",
"name": "example.mydomain.com",
"device_id": 1,
"server_id": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'ip' => '192.168.1.1',
'name' => 'example.mydomain.com',
'device_id' => 1,
'server_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3,
"device_id": 407,
"server_id": 9,
"ip": "109.32.51.139",
"name": "jacobi.net",
"created_at": "2026-04-21 13:17:18",
"updated_at": "2026-04-21 13:17:18"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Zone
requires authentication
Deletes a zone record.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/dns-manager/zones/13" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/13'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/13';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Zone Records
requires authentication
This endpoint returns a zone records with zone information for given id
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add Zone Record
requires authentication
This endpoint allow to create zone record.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/create" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\": \"[email protected]\"
},
\"MR\": {
\"newname\": \"newmail.example.com\"
},
\"MX\": {
\"preference\": 10,
\"exchange\": \"mail.example.com\"
},
\"NAPTR\": {
\"order\": 100,
\"preference\": 10,
\"flags\": \"U\",
\"services\": \"E2U+sip\",
\"regexp\": \"!^.*$!sip:[email protected]!\",
\"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\"
}
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/create'
payload = {
"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": "[email protected]"
},
"MR": {
"newname": "newmail.example.com"
},
"MX": {
"preference": 10,
"exchange": "mail.example.com"
},
"NAPTR": {
"order": 100,
"preference": 10,
"flags": "U",
"services": "E2U+sip",
"regexp": "!^.*$!sip:[email protected]!",
"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"
}
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/create';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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.0,
'horiz_pre' => 100.0,
'vert_pre' => 10.0,
'latitude' => '52 22 23.0 N',
'longitude' => '4 53 32.0 E',
'altitude' => 5.0,
],
'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' => '[email protected]',
],
'MR' => [
'newname' => 'newmail.example.com',
],
'MX' => [
'preference' => 10,
'exchange' => 'mail.example.com',
],
'NAPTR' => [
'order' => 100,
'preference' => 10,
'flags' => 'U',
'services' => 'E2U+sip',
'regexp' => '!^.*$!sip:[email protected]!',
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Zone Record
requires authentication
This endpoint deletes zone record.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/dns-manager/zones/5/records/delete" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"line\": 1,
\"type\": \"A\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/5/records/delete'
payload = {
"line": 1,
"type": "A"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/5/records/delete';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'line' => 1,
'type' => 'A',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Zone Record
requires authentication
This endpoint allow to edit zone record.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/update" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\": \"[email protected]\"
},
\"MR\": {
\"newname\": \"newmail.example.com\"
},
\"MX\": {
\"preference\": 10,
\"exchange\": \"mail.example.com\"
},
\"NAPTR\": {
\"order\": 100,
\"preference\": 10,
\"flags\": \"U\",
\"services\": \"E2U+sip\",
\"regexp\": \"!^.*$!sip:[email protected]!\",
\"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\"
}
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/update'
payload = {
"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": "[email protected]"
},
"MR": {
"newname": "newmail.example.com"
},
"MX": {
"preference": 10,
"exchange": "mail.example.com"
},
"NAPTR": {
"order": 100,
"preference": 10,
"flags": "U",
"services": "E2U+sip",
"regexp": "!^.*$!sip:[email protected]!",
"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"
}
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/dns-manager/zones/11/records/update';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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.0,
'horiz_pre' => 100.0,
'vert_pre' => 10.0,
'latitude' => '52 22 23.0 N',
'longitude' => '4 53 32.0 E',
'altitude' => 5.0,
],
'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' => '[email protected]',
],
'MR' => [
'newname' => 'newmail.example.com',
],
'MX' => [
'preference' => 10,
'exchange' => 'mail.example.com',
],
'NAPTR' => [
'order' => 100,
'preference' => 10,
'flags' => 'U',
'services' => 'E2U+sip',
'regexp' => '!^.*$!sip:[email protected]!',
'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',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Usage Collector
List of Limits For Device
requires authentication
Returns a paginated list of limits for devices with configured limits
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/usage-collector/limits'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/usage-collector/limits';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show of Limits For Device
requires authentication
Returns limits for device
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/usage-collector/1/limits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Limits For Device
requires authentication
Returns limits for device
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/usage-collector/1/limits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\": 5,
\"warning_notification_treshold\": 110
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits'
payload = {
"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": 5,
"warning_notification_treshold": 110
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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' => 5,
'warning_notification_treshold' => 110,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Limits For Device
requires authentication
Returns limits for device
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/admin/usage-collector/1/limits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"limit_type\": \"TrafficAggregation\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits'
payload = {
"limit_type": "TrafficAggregation"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'limit_type' => 'TrafficAggregation',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Tags
List Tags
requires authentication
Returns a paginated list of tags.
Show tag
requires authentication
Display detailed information about a single tag by its ID.
Create tag
requires authentication
Store a new tag in the system using validated request data.
Update tag
requires authentication
Updates the specified tag with provided data.
Delete tag
requires authentication
Removes the specified tag from the system.
Assign multiple tags to specified entity
requires authentication
Assigns multiple tags to specified entity
Unassign multiple tags from specified entity
requires authentication
Unassigns multiple tags from specified entity
Authorization Endpoints
Login
This endpoint allows a user to authenticate and receive an access token.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/login" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\",
\"password\": \"secret123\",
\"device_name\": \"iPhone 13\",
\"token_ttl\": 0
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/login'
payload = {
"email": "[email protected]",
"password": "secret123",
"device_name": "iPhone 13",
"token_ttl": 0
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/login';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => '[email protected]',
'password' => 'secret123',
'device_name' => 'iPhone 13',
'token_ttl' => 0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 112,
"name": "iPhone 13",
"last_used_at": "-",
"expires_at": "-",
"token": "112|TT67ipL9gve55ujQNiVpI4CtK4OOW5F6rkzCdPV15cdccbc0",
"created_at": "2025-10-21 15:47:12"
}
}
Example response (403):
{
"success": false,
"status": "error",
"message": "Your account is not active or has been banned."
}
Example response (422):
{
"success": false,
"status": "error",
"message": "Data validation has failed. Please correct the errors and try again.",
"errors": {
"email": [
"The provided email address is incorrect."
],
"password": [
"The provided password is incorrect."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remind Password
Sends a password reset link to the provided email address, if it exists in the system.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/password/remind" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/password/remind'
payload = {
"email": "[email protected]"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/password/remind';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => '[email protected]',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "Success! An email has been sent to your inbox.",
"data": null
}
Example response (403):
{
"success": false,
"status": "error",
"message": "Your account is not active or has been banned."
}
Example response (404):
{
"success": false,
"status": "error",
"message": "The provided email address is incorrect."
}
Example response (500):
{
"success": false,
"status": "error",
"message": "Unable to send email. Please contact your administrator."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Restore Password
Resets a user's password using a valid reset token.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/password/restore" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"123456abcdef\",
\"password\": \"NewSecureP@ss123\",
\"password_confirmation\": \"NewSecureP@ss123\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/password/restore'
payload = {
"token": "123456abcdef",
"password": "NewSecureP@ss123",
"password_confirmation": "NewSecureP@ss123"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/password/restore';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'token' => '123456abcdef',
'password' => 'NewSecureP@ss123',
'password_confirmation' => 'NewSecureP@ss123',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "Your password has been updated successfully.",
"data": null
}
Example response (422):
{
"success": false,
"status": "error",
"message": "Your token is incorrect or this account does not exist."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Activate User Account
Activates a user account based on the provided activation token.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/activate/9bdf52c2-2e13-4f9c-a53d-2b3f45ea9c20" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/activate/9bdf52c2-2e13-4f9c-a53d-2b3f45ea9c20'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/activate/9bdf52c2-2e13-4f9c-a53d-2b3f45ea9c20';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "Your account has been activated. You may now log in.",
"data": null
}
Example response (400):
{
"success": false,
"status": "error",
"message": "Activation failed. Please contact support or try again."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Active SSO Providers
Returns all enabled SSO providers available for the CLIENT scope.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/oauth/providers" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/oauth/providers'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/oauth/providers';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"slug": "GitHubClientArea"
},
{
"slug": "GoogleClientArea"
},
{
"slug": "CustomClientArea"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OAuth2 Redirect
Returns provider authorization URL for the given provider slug.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/oauth/redirect" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"provider\": \"Google\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/oauth/redirect'
payload = {
"provider": "Google"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/oauth/redirect';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'provider' => 'Google',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"url": "https://provider.url.com",
"provider": "GitHubClientArea",
"state": "enabled"
}
}
Example response (404):
{
"success": false,
"status": "error",
"message": "Invalid or unsupported authentication provider."
}
Example response (422):
{
"success": false,
"status": "error",
"message": "Incorrect OAuth provider configuration."
}
Example response (500):
{
"success": false,
"status": "error",
"message": "An error occurred while creating the authorization URL."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OAuth2 Exchange
Exchanges the authorization code from the frontend for an API access token.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/oauth/callback" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"provider\": \"Google\",
\"code\": \"4\\/0AfJohXKXYZ...\",
\"state\": \"abc123xyz\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/oauth/callback'
payload = {
"provider": "Google",
"code": "4\/0AfJohXKXYZ...",
"state": "abc123xyz"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/oauth/callback';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'provider' => 'Google',
'code' => '4/0AfJohXKXYZ...',
'state' => 'abc123xyz',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 112,
"name": "iPhone 13",
"last_used_at": "-",
"expires_at": "-",
"token": "112|TT67ipL9gve55ujQNiVpI4CtK4OOW5F6rkzCdPV15cdccbc0",
"created_at": "2025-10-21 15:47:12"
}
}
Example response (400):
{
"success": false,
"status": "error",
"message": "Unable to retrieve user email from the provider."
}
Example response (403):
{
"success": false,
"status": "error",
"message": "The user account [email protected] is not active."
}
Example response (404):
{
"success": false,
"status": "error",
"message": "Invalid or unsupported authentication provider."
}
Example response (404):
{
"success": false,
"status": "error",
"message": "Unable to find user with email address: [email protected]."
}
Example response (500):
{
"success": false,
"status": "error",
"message": "OAuth exchange failed"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Logout
requires authentication
Revoke the current access token to log out the authenticated user.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/logout'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/logout';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": null
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Client Endpoints
System
Get Translations
Returns all language translations for the specified locale.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/system/translations/en" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/system/translations/en'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/system/translations/en';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"lang_error_toast_heading": "An error occurred!",
"lang_success_toast_heading": "Success!",
"log_in": "Log in",
"log_out": "Log out",
"tab": {
"summary": "Summary",
"detailed_information": "Detailed Information",
"graphs": "Graphs",
"traffic_statistics": "Traffic Statistics",
"power_usage": "Power Usage",
"reverse_dns": "Reverse DNS",
"ip_management": "IP Address Management",
"outlets": "Outlets"
},
"title": {
"impersonating_as_client": "Logging in as client...",
"activating_user": "Activating Account...",
"oauth_callback": "Connecting Account..."
},
"messages": {
"impersonating_description": "Please wait while we securely log you in as the selected client. This process may take a few seconds.",
"activating_user_description": "Please wait while we activate your account. This will only take a moment.",
"oauth_callback_description": "Please wait while we securely connect your account. This process may take a few seconds."
},
"section_title": {
"bandwidth": "Bandwidth",
"power_usage": "Power Usage",
"outlets": "Outlets",
"detailed_information": "Detailed Information",
"device_parts": "Device Parts",
"graphs": "Graphs",
"ip_addresses_management": "IP Addresses Management",
"power_usage_statistic": "Power Usage Statistics",
"bandwidth_intervals": "Bandwidth Intervals",
"network_ports": "Network Ports",
"ping_status": "Ping & Status",
"name": "Name"
},
"boxes": {
"bandwith_in": "Inbound Bandwidth",
"bandwith_out": "Outbound Bandwidth",
"bandwith_total": "Total Bandwidth"
},
"table_headers": {
"base": "Base",
"ipmi_settings": "IPMI Settings",
"system": "System",
"ssh_settings": "SSH Settings",
"snmp_settings": "SNMP Settings",
"type": "Type",
"name": "Name",
"label": "Label",
"device": "Device",
"last_hour_traffic": "Last Hour Traffic",
"last_day_traffic": "Last Day Traffic",
"last_month_traffic": "Last Month Traffic",
"interval": "Interval",
"bandwidth_in": "Inbound Bandwidth",
"bandwidth_out": "Outbound Bandwidth",
"bandwidth_total": "Total Bandwidth",
"fingerprint": "Fingerprint",
"status": "Status",
"actions": "Actions",
"id": "ID",
"number": "Number",
"power_usage": "Power Usage",
"ip_address": "IP Address",
"rdata": "RDATA",
"hostname": "Hostname",
"created": "Created",
"description": "Description",
"iso_url": "ISO URL"
},
"interval_table": {
"last_1hour": "Last 1 Hour",
"last_6hours": "Last 6 Hours",
"last_1day": "Last 1 Day",
"last_2days": "Last 2 Days",
"last_1week": "Last 1 Week",
"last_1month": "Last 1 Month",
"last_6months": "Last 6 Months",
"last_1year": "Last 1 Year",
"current_month": "Current Month"
},
"power_usage_table": {
"average_daily_usage": "Average Daily Usage",
"average_weekly_usage": "Average Weekly Usage",
"average_monthly_usage": "Average Monthly Usage",
"previous_month_average_usage": "Previous Month Average Usage"
},
"chart": {
"inbound_total": "Traffic IN",
"outbound_total": "Traffic OUT",
"total_bound_bits": "Traffic IN & OUT",
"95_percentile": "95th Percentile",
"power_usage": "Power Usage"
},
"stats": {
"power_daily_usage": "Daily Usage",
"power_weekly_usage": "Weekly Usage",
"power_monthly_usage": "Monthly Usage",
"power_previous_month_usage": "Previous Month"
},
"panel_branding": {
"title": "Panel Branding",
"allowed_formats": "SVG, PNG or JPG",
"click_to_upload": "Click to upload",
"change_logo": "Change Logo",
"change_favicon": "Change Favicon",
"choose_color_scheme": "Choose Color Scheme",
"action_saved": "Save Changes",
"action_restore": "Restore Defaults"
},
"login_page": {
"login_title": "Login",
"register": "Register",
"impersonating_as_client": "Loading Client Panel Dashboard...",
"reset_password_title": "Reset Your Password",
"reset_password_desc": "Forgot your password? Enter your email address below to begin the reset process.",
"message_sent_title": "Message Sent",
"message_sent_desc": "We have sent a message to your email address with a link to reset your password."
},
"dropdown": {
"server_actions": "Server Actions",
"power_control": "Power Control"
},
"status": {
"active": "Active"
},
"nav": {
"your_services": "Your Services",
"iso_images": "ISO Images",
"ssh_keys": "SSH Keys",
"my_account": "My Account",
"sign_out": "Sign Out"
},
"banner": {
"services_title": "Your Services",
"services_desc": "A list of all services assigned to your account.",
"iso_images_title": "ISO Images",
"iso_images_desc": "A list of all ISO Images created in your account.",
"ssh_keys_title": "SSH Keys",
"ssh_keys_desc": "A list of all SSH Keys created in your account.",
"my_account_title": "My Account",
"my_account_desc": "Summary of your account details and settings"
},
"inputs": {
"first_name_title": "First Name",
"first_name_placeholder": "First Name Placeholder",
"last_name_title": "Last Name",
"last_name_placeholder": "Last Name Placeholder",
"company_name_title": "Company Name",
"company_name_placeholder": "Company Name Placeholder",
"email_address_title": "Email Address",
"email_address_placeholder": "Email Address Placeholder",
"languages_title": "Language",
"languages_placeholder": "Language Placeholder",
"timezones_title": "Timezone",
"timezones_placeholder": "Timezone Placeholder",
"current_password_title": "Current Password",
"current_password_placeholder": "Current Password Placeholder",
"new_password_title": "New Password",
"new_password_placeholder": "New Password Placeholder",
"confirm_new_password_title": "Confirm New Password",
"confirm_new_password_placeholder": "Confirm New Password Placeholder",
"generated_code_title": "Generated Code",
"generated_code_placeholder": "Generated Code Placeholder",
"template_title": "Template",
"template_placeholder": "Template Placeholder",
"hostname_title": "Hostname",
"hostname_placeholder": "Hostname Placeholder",
"username_title": "Username",
"username_placeholder": "Username Placeholder",
"root_password_title": "Root Password",
"root_password_placeholder": "Root Password Placeholder",
"password_title": "Password",
"password_placeholder": "Password Placeholder",
"ssh_keys_title": "SSH Keys",
"ssh_keys_placeholder": "SSH Keys Placeholder",
"disk_layout_title": "Disk Layout",
"disk_layout_placeholder": "Disk Layout Placeholder",
"extras_title": "Extras",
"extras_placeholder": "Extras Placeholder",
"remember_me_title": "Remember Me"
},
"general": {
"all": "all",
"save_changes": "Save Changes",
"cancel": "Cancel",
"confirm": "Confirm",
"unknown": "Unknown",
"unassigned": "Unassigned",
"not_found_or_unauthorized": "The requested entity does not exist or does not belong to you.",
"pdu_required": "PDU Management extension must be enabled to perform this action.",
"manage": "Manage"
},
"auth": {
"missing_bearer_token": "Missing bearer token.",
"unauthorized_admin_access_only": "Unauthorized. Admin access only.",
"invalid_email": "The provided email address is incorrect.",
"email_send_error": "Unable to send email. Please contact your administrator.",
"email_send_success": "Success! An email has been sent to your inbox.",
"invalid_token": "Your token is incorrect or this account does not exist.",
"validation_error": "Password reset failed due to validation errors.",
"password_reset_success": "Your password has been updated successfully.",
"activation_success": "Your account has been activated. You may now log in.",
"activation_failed": "Activation failed. Please contact support or try again.",
"user_not_found": "User not found.",
"invalid_password": "The provided password is incorrect.",
"your_account_is_inactive": "Your account is not active or has been banned.",
"invalid_bearer_token": "Invalid bearer token.",
"impersonated_user_not_found": "Impersonated user not found.",
"impersonated_user_inactive": "Impersonated user account is inactive.",
"only_admin_can_impersonate": "Only admin users are allowed to impersonate other users.",
"missing_impersonate_ability": "Your access token does not have permission to impersonate other users.",
"oauth_invalid_provider": "Invalid or unsupported authentication provider.",
"oauth_incorrect_configuration": "Incorrect OAuth provider configuration.",
"oauth_authorization_error": "An error occurred while creating the authorization URL: :error",
"oauth_exchange_error": "OAuth exchange failed: :error",
"oauth_missing_email": "Unable to retrieve user email from the provider.",
"oauth_user_not_found": "Unable to find user with email address: :email.",
"oauth_user_inactive": "The user account :email is not active.",
"oauth_invalid_provider_response": "Invalid or unsupported authentication provider response.",
"oauth_redirect_failed": "Failed to start OAuth login. Please try again later.",
"oauth_connecting": "Connecting your account...",
"oauth_missing_parameters": "Missing authorization parameters.",
"oauth_invalid_state": "Invalid state parameter.",
"oauth_authentication_failed": "Authentication failed. Please try again.",
"oauth_exchange_failed": "OAuth exchange failed. Please try again later.",
"login_with_GitHubClientArea": "Sign in with GitHub",
"login_with_GoogleClientArea": "Sign in with Google",
"login_with_CustomClientArea": "Sign in with OAuth Provider"
},
"service": {
"not_found_or_unauthorized": "The requested service does not exist, is inactive, or does not belong to you.",
"power_action_error": "An error occurred while attempting to perform the :action action on the server.",
"outlet_action_error": "An error occurred while attempting to perform the :action action on the outlet."
},
"2fa": {
"already_enabled": "Two-factor authentication is already enabled.",
"configuration_error": "There was an error while verifying the two-factor configuration.",
"verification_failed": "Invalid code. Two-factor authentication failed.",
"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.",
"please_provide_the_valid_password_for_your_account": "Please provide the valid password for your account.",
"no_valid_backup_code_specified_into_configuration": "No valid backup code is stored in your configuration.",
"invalid_or_empty_backup_code": "The backup code provided is invalid or has not been entered.",
"enabled_successfully": "Two-factor authentication has been enabled successfully.",
"disabled_successfully": "Two-factor authentication has been disabled successfully.",
"enable_modal": {
"title": "Two-Factor Authentication",
"desc": "Please use an authenticator app, such as Google Authenticator, to scan the QR code below.",
"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."
},
"disable_modal": {
"title": "Disable Two-Factor Authentication",
"desc": "To disable two-factor authentication, please confirm your current account password.",
"input_title": "Current Password"
},
"2fa_title": "Two-Factor Authentication",
"2fa_code_desc": "To confirm your identity, please enter the six-digit authentication code from your app.",
"2fa_backup_code_desc": "If you do not have access to the app, please enter a backup code below.",
"input_title": "Authentication code",
"input_placeholder": "Enter your 6-digit code",
"or": "or",
"use_backup_code": "Use Backup Code",
"use_standard_code": "Use Authentication Code"
},
"login_backup_code": {
"input_title": "Backup code",
"input_placeholder": "Enter your backup code"
},
"actions": {
"boot": "Boot",
"reboot": "Reboot",
"shutdown": "Shutdown",
"boot_modal_title": "Boot Server",
"boot_modal_desc": "Are you sure you want to boot this server?",
"shutdown_modal_title": "Shutdown Server",
"shutdown_modal_desc": "Are you sure you want to shut down this server?",
"reboot_modal_title": "Reboot Server",
"reboot_modal_desc": "Are you sure you want to reboot this server?",
"cold_reset_modal_title": "Cold Reset BMC",
"cold_reset_modal_desc": "This will force a cold reset of the BMC. Are you sure?",
"rescue_mode_enable_title": "Enable Rescue Mode",
"rescue_mode_enable_desc": "Do you really want to reboot the device in rescue mode?",
"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.",
"rescue_mode_enable_desc2": "Downtime due to reboot: approximately 5 minutes.",
"rescue_mode_disable_title": "Disable Rescue Mode",
"rescue_mode_disable_desc": "This will boot the server into its normal OS. Proceed?",
"osreinstall_modal_title": "Reinstall Operating System",
"outletOn": "Outlet On",
"outletOff": "Outlet Off",
"outletReboot": "Outlet Reboot"
},
"service_widget": {
"service": "Service",
"ip_address": "IP Adress",
"location": "Location",
"rack": "Rack",
"label": "Label",
"device_status": "Device Status",
"mac_address": "MAC Address",
"uptime": "UpTime",
"operating_system": "Operating System"
},
"graphs": {
"aggregate_traffic": "Aggregate Traffic",
"ping_response": "Ping Response",
"status": "Status Graphs",
"average_loads": "Average Loads For Device",
"power_usage": "Server Power Usage"
},
"vnc_console": {
"modal_title": "noVNC KVM Console",
"connecting_desc": "We’re establishing the console connection for you. This may take a moment, please wait.",
"failed_desc": "The console connection has been established successfully! Please click the button below to open the console.",
"connected_desc": "Failed to establish the console connection. Please try again or contact support if the problem persists.",
"action_open": "Open Console",
"action_try_again": "Try Again",
"insert_username": "Insert Username",
"insert_password": "Insert Password",
"close_session": "Close Session",
"console_status": "Console Status",
"loading_desc": "We are loading the console. This may take a moment, please wait.",
"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."
},
"404": {
"title": "Something's missing.",
"desc": "The resource you are looking for does not exist or has been removed.",
"back_to_services": "Back to Service List",
"back_to_login": "Back to Login"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show System Configuration
requires authentication
Returns basic system configuration.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/system-settings" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/system-settings'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/system-settings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Users
Autologin with Token
Logs the user in using a one-time autologin token and returns a new API access token. The token will be valid for 10 minutes.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/user/autologin" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"e32cc8f1004a581583b2702c1fbf8354\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/autologin'
payload = {
"token": "e32cc8f1004a581583b2702c1fbf8354"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/autologin';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'token' => 'e32cc8f1004a581583b2702c1fbf8354',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Authenticated User
requires authentication
Returns the currently authenticated user's details.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 597,
"username": "mccullough.hassan",
"firstname": "Estefania",
"lastname": "Wuckert",
"name": "Estefania Wuckert",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/fded91deb9f02ac8c5fc55e74de1bc12?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/fded91deb9f02ac8c5fc55e74de1bc12?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update User
requires authentication
Updates the currently authenticated user's details with the provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/user/edit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\",
\"firstname\": \"John\",
\"lastname\": \"Doe\",
\"company\": \"Acme Inc.\",
\"locale\": \"en\",
\"timezone\": 133
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/edit'
payload = {
"email": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"company": "Acme Inc.",
"locale": "en",
"timezone": 133
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/edit';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => '[email protected]',
'firstname' => 'John',
'lastname' => 'Doe',
'company' => 'Acme Inc.',
'locale' => 'en',
'timezone' => 133,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 598,
"username": "carlee.casper",
"firstname": "Adalberto",
"lastname": "Gibson",
"name": "Adalberto Gibson",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/ef2829e582693cc66793dc67d483831b?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/ef2829e582693cc66793dc67d483831b?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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update User Password
requires authentication
Allows the authenticated user to change their password by providing the current password and a new one.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/user/edit-password" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"current_password\": \"OldP@ssword123\",
\"password\": \"NewSecureP@ss123\",
\"password_confirmation\": \"NewSecureP@ss123\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/edit-password'
payload = {
"current_password": "OldP@ssword123",
"password": "NewSecureP@ss123",
"password_confirmation": "NewSecureP@ss123"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/edit-password';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'current_password' => 'OldP@ssword123',
'password' => 'NewSecureP@ss123',
'password_confirmation' => 'NewSecureP@ss123',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Generate Auto-Login Link
requires authentication
Creates a one-time auto-login link for a specific user.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/user/autologin" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/autologin'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/autologin';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"link": "https://your-easydcim.com/client/impersonate?token=43128ab30d06c9bf5eb7a1c2f0274bf4"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.SSH Keys
List SSH Keys
requires authentication
Returns a paginated list of SSH keys for the authenticated user.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 11,
"name": "sunt ullam",
"ssh_key": "ssh-rsa NjczZGMzZmY1M2VhMDFlYWY5YTdlN2ExMmM5ZTEwNjI3OGMzMTk2MTEwOGM4NmNlZTAxMWUzNGViM2Q2ZDFlNA== user@host",
"default": false,
"fingerprint": "72:05:0f:a5:ca:d4:ac:33:82:b2:19:40:80:6c:e3:b4",
"created_at": "2026-04-21 13:15:33"
},
{
"id": 12,
"name": "et exercitationem",
"ssh_key": "ssh-rsa M2NmZmRiMDk5OTZlMzcxMjRmY2U3ZmZiNGMyMDlmNGYwZGNmNzBiNmNiOWExNWY0MGYxMDFiMzI4MjMxOTQ4NQ== user@host",
"default": false,
"fingerprint": "0a:21:76:da:a5:fc:0e:24:46:c7:83:2a:1e:0c:7d:c1",
"created_at": "2026-04-21 13:15:33"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create SSH Key
requires authentication
Creates a new SSH key associated with the authenticated client.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/user/ssh-keys" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Public Key\",
\"ssh_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...\",
\"default\": true
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys'
payload = {
"name": "Public Key",
"ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...",
"default": true
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Public Key',
'ssh_key' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...',
'default' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 13,
"name": "facilis asperiores",
"ssh_key": "ssh-rsa NGFlMGM5Mjk5YmRmNjliN2I1MTBkZDM5ZGMyOTE5ZmZkYzcwYzgyMDg0ZDZkYmQxMjRmYjE4ZjJmYWZiYWUwOQ== user@host",
"default": false,
"fingerprint": "31:13:37:68:15:9a:f9:e6:59:f0:9d:72:f8:a7:77:4a",
"created_at": "2026-04-21 13:15:33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update SSH Key
requires authentication
Updates a given SSH key for the authenticated user.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/user/ssh-keys/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Public Key\",
\"ssh_key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...\",
\"default\": true
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/3'
payload = {
"name": "Public Key",
"ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...",
"default": true
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/3';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Public Key',
'ssh_key' => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...',
'default' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 14,
"name": "hic qui",
"ssh_key": "ssh-rsa YjZiYjRjNjI4NWMyN2JiYzZjMGM1Mzg5MTAwYzY0OGUzODQ0NDNjMzNkZDU1MDQyYjNiMjE2NGZmMWMwMmI1OA== user@host",
"default": false,
"fingerprint": "4b:df:7b:5d:b4:a2:ba:e9:c6:2a:3e:61:77:56:cc:45",
"created_at": "2026-04-21 13:15:33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set SSH Key as Default
requires authentication
Sets a given SSH key as the default key for the authenticated client.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/user/ssh-keys/7/set-as-default" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/7/set-as-default'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/7/set-as-default';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 15,
"name": "et quidem",
"ssh_key": "ssh-rsa NTM4MTI1N2NiY2UxNjQxYjNiZjNmNjk0NmNmY2NkZmU3MWY3NGI1OTMzNmM2NDQ5YjQ5MjIxYTMxYmFiZjcxMQ== user@host",
"default": false,
"fingerprint": "ac:79:69:14:c7:05:40:d3:c3:08:c4:cc:80:96:03:74",
"created_at": "2026-04-21 13:15:33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete SSH Key
requires authentication
Deletes a specific SSH key belonging to the authenticated client.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/client/user/ssh-keys/19" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/19'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/user/ssh-keys/19';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Services
List Services
requires authentication
Returns a paginated list of services for the authenticated client.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services'
params = {
'filter': 'active',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'filter' => 'active',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 11,
"related_id": 330,
"related": {
"label": "tenetur",
"model": "mollitia",
"location": "Labadie, Jast and Zemlak",
"location_flag": "Canada.png",
"metadata": []
},
"type": "Colocation",
"status": "",
"created_at": "2026-04-21 13:15:36"
},
{
"id": 12,
"related_id": 331,
"related": {
"label": "natus",
"model": "asperiores",
"location": "Volkman-Steuber",
"location_flag": "Germany.png",
"metadata": []
},
"type": "Server",
"status": "activated",
"created_at": "2026-04-21 13:15: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show Service
requires authentication
Returns detailed information about a specific service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 13,
"related_id": 332,
"type": "Colocation",
"status": "activated",
"created_at": "2026-04-21 13:15:41",
"related": {
"label": "quae",
"model": "odit",
"location": "Cronin Group",
"location_flag": "UK.png",
"rack": "Unknown",
"device_status": "running",
"os_installation": 0,
"uptime": {
"is_down": false,
"value": "Unknown"
},
"image": null,
"ip_addresses": [],
"metadata": [],
"metadataGroups": []
},
"access_level": {
"id": 15,
"name": "odio",
"type": "Server",
"default": false,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"location\";i:1;s:5:\"model\";i:2;s:11:\"description\";i:3;s:8:\"position\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:17:\"left_sidebar_link\";i:1;s:20:\"widget_network_ports\";i:2;s:9:\"filtering\";i:3;s:17:\"widget_last_month\";i:4;s:23:\"widget_last_month_graph\";}s:5:\"power\";a:6:{i:0;s:7:\"outlets\";i:1;s:20:\"widget_average_usage\";i:2;s:17:\"left_sidebar_link\";i:3;s:23:\"widget_last_month_graph\";i:4;s:17:\"widget_last_month\";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:22:\"rdns_left_sidebar_link\";i:1;s:11:\"update_rdns\";i:2;s:11:\"create_rdns\";i:3;s:11:\"delete_rdns\";}}"
}
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Service Bandwidth
requires authentication
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.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/101/bandwidth" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"startDate\": \"2024-01-01 00:00:00\",
\"endDate\": \"2024-01-31 23:59:59\",
\"units\": \"GB\",
\"ports\": [
12,
100
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/101/bandwidth'
payload = {
"startDate": "2024-01-01 00:00:00",
"endDate": "2024-01-31 23:59:59",
"units": "GB",
"ports": [
12,
100
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/101/bandwidth';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'startDate' => '2024-01-01 00:00:00',
'endDate' => '2024-01-31 23:59:59',
'units' => 'GB',
'ports' => [
12,
100,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Service Power Usage
requires authentication
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.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/101/powerusage" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"startDate\": \"2024-01-01 00:00:00\",
\"endDate\": \"2024-01-31 23:59:59\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/101/powerusage'
payload = {
"startDate": "2024-01-01 00:00:00",
"endDate": "2024-01-31 23:59:59"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/101/powerusage';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'startDate' => '2024-01-01 00:00:00',
'endDate' => '2024-01-31 23:59:59',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"AVG_TOTAL_USAGE": 10,
"units": "Amps"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign Metadata To Service
requires authentication
Assigns metadata for specified device associated with service.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/1/assign-metadata" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"slug\": \"ipmi.ip\",
\"value\": \"192.168.56.180\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/1/assign-metadata'
payload = {
"slug": "ipmi.ip",
"value": "192.168.56.180"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/1/assign-metadata';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'slug' => 'ipmi.ip',
'value' => '192.168.56.180',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Perform Power Action
requires authentication
Executes a power-related action on a device assigned to the given service. This includes booting, rebooting, or shutting down the device.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/power/action" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"action\": \"boot\",
\"device_id\": 1
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/power/action'
payload = {
"action": "boot",
"device_id": 1
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/power/action';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'action' => 'boot',
'device_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Parts
List Service Parts
requires authentication
Returns a paginated list of parts related to a specific service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/parts?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/parts'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/parts';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 333,
"label": "fugiat",
"type": "qui"
},
{
"id": 334,
"label": "vitae",
"type": "magnam"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Power Ports
List Service Power Ports
requires authentication
Returns a paginated list of power ports related to a specific service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/power-ports?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/power-ports'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/power-ports';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 350,
"port_number": 4,
"port_label": "numquam",
"user_label": "soluta",
"outlet_state": "Outlet On",
"connected_item": null,
"connected_port": null,
"power_usage": 39,
"power_usage_units": "Amps",
"power_usage_value": 39,
"power_usage_unit": "amps",
"power_usage_label": "39 Amps"
},
{
"id": 351,
"port_number": 12,
"port_label": "voluptatem",
"user_label": "ullam",
"outlet_state": "Outlet Off",
"connected_item": null,
"connected_port": null,
"power_usage": 88,
"power_usage_units": "Amps",
"power_usage_value": 88,
"power_usage_unit": "amps",
"power_usage_label": "88 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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Perform action on a specific Power Port
requires authentication
Executes an outlet action (outletOn, outletOff, outletReboot) for a given port.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/power-ports/action" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"port_id\": 45,
\"action\": \"outletOff\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/power-ports/action'
payload = {
"port_id": 45,
"action": "outletOff"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/power-ports/action';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'port_id' => 45,
'action' => 'outletOff',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 352,
"port_number": 10,
"port_label": "et",
"user_label": "ut",
"outlet_state": "Outlet On",
"connected_item": null,
"connected_port": null,
"power_usage": 27,
"power_usage_units": "Amps",
"power_usage_value": 27,
"power_usage_unit": "amps",
"power_usage_label": "27 Amps"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ports
List Service Ports
requires authentication
Returns a paginated list of ports related to a specific service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/ports'
params = {
'with_traffic': '1',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ports';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_traffic' => '1',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 3270,
"name": null,
"port_number": 34,
"port_label": "ea",
"user_label": "sed",
"description": "Repudiandae voluptates nobis natus rerum atque vitae.",
"if_type": "voiceDID",
"adminstate": "up",
"opstate": "up",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "1 kbps"
},
{
"id": 3271,
"name": null,
"port_number": 37,
"port_label": "quod",
"user_label": "ut",
"description": "Modi accusantium excepturi laboriosam veniam nostrum doloribus aspernatur quas.",
"if_type": "interleave",
"adminstate": "up",
"opstate": "up",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "10 kbps"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Sensors
List Sensors
requires authentication
Returns a paginated list of sensors associated with the service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/1/sensors?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/1/sensors'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/1/sensors';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 63,
"item_id": 340,
"name": "tempora",
"class": "Fans",
"type": "Thermal",
"unit": "Percent",
"index": "Thermal",
"reading": 732,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:15:55",
"updated_at": "2026-04-21 13:15:55"
},
{
"id": 64,
"item_id": 341,
"name": "pariatur",
"class": "Power Supply",
"type": "Thermal",
"unit": "Watts",
"index": "Thermal",
"reading": 822,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:15:56",
"updated_at": "2026-04-21 13:15:56"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show sensor
requires authentication
Display detailed information about a single sensor associated with the service by its ID.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/1/sensors/11" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/1/sensors/11'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/1/sensors/11';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 65,
"item_id": 342,
"name": "qui",
"class": "Fans",
"type": "Power",
"unit": "Watts",
"index": "Power",
"reading": 714,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-04-21 13:15:57",
"updated_at": "2026-04-21 13:15:57"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Graphs
Export Graph
requires authentication
Exports a graph data for a given target
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/graphs/42/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"AggregateTraffic\",
\"target\": \"service\",
\"start\": \"2025-04-01 00:00:00\",
\"end\": \"2025-04-30 23:59:59\",
\"raw\": false
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/graphs/42/export'
payload = {
"type": "AggregateTraffic",
"target": "service",
"start": "2025-04-01 00:00:00",
"end": "2025-04-30 23:59:59",
"raw": false
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/graphs/42/export';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'AggregateTraffic',
'target' => 'service',
'start' => '2025-04-01 00:00:00',
'end' => '2025-04-30 23:59:59',
'raw' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
]
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OS Installation
List ISO Images
requires authentication
Returns a paginated list of ISO images available to the authenticated client.
Example request:
curl --request GET \
--get "https://your-easydcim.com/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/os/isoimages'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/os/isoimages';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 1,
"name": "earum-iso",
"iso_url": "https://fritsch.info/consequatur-et-molestiae-debitis-enim-maiores-qui-molestiae.html",
"status": 3,
"download": {
"status": "finished",
"message": "The ISO image download has completed successfully."
},
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
},
{
"id": 2,
"name": "enim-iso",
"iso_url": "http://huel.com/laborum-sequi-praesentium-modi-qui-quasi",
"status": 2,
"download": {
"status": "started",
"message": "Downloading ISO image..."
},
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17: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/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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create ISO Image
requires authentication
Creates a new ISO image for the authenticated client.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/os/isoimages" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Ubuntu Server ISO\",
\"iso_url\": \"https:\\/\\/example.com\\/images\\/ubuntu.iso\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/os/isoimages'
payload = {
"name": "Ubuntu Server ISO",
"iso_url": "https:\/\/example.com\/images\/ubuntu.iso"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/os/isoimages';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Ubuntu Server ISO',
'iso_url' => 'https://example.com/images/ubuntu.iso',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 3,
"name": "odio-iso",
"iso_url": "https://www.klocko.com/ipsa-sunt-et-eligendi-et-corrupti-non",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update ISO Image
requires authentication
Updates the name of an existing ISO image for the authenticated client.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/os/isoimages/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Updated ISO Name\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/os/isoimages/3'
payload = {
"name": "Updated ISO Name"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/os/isoimages/3';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Updated ISO Name',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 4,
"name": "sint-iso",
"iso_url": "http://www.bradtke.org/delectus-pariatur-at-autem-saepe.html",
"status": 2,
"download": {
"status": "started",
"message": "Downloading ISO image..."
},
"created_at": "2026-04-21 13:17:08",
"updated_at": "2026-04-21 13:17:08"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete ISO Image
requires authentication
Deletes a specific ISO image belonging to the authenticated client.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/client/os/isoimages/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/os/isoimages/3'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/os/isoimages/3';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List OS Templates
requires authentication
Returns a paginated list of OS templates available for the given service.
Optionally, you can include a list of addons (based on template tags) by using the with_addons query parameter.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/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" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/templates'
params = {
'with_addons': '1',
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/templates';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'with_addons' => '1',
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 45,
"template_id": 45,
"name": "vel",
"tags": [
"libero",
"rerum",
"aut"
],
"architecture": "x86",
"cache_folder": "quia",
"mirror": "https://www.mueller.com/incidunt-distinctio-temporibus-aliquam-qui-sit-sed",
"edition": "voluptatum",
"iso_url": "http://stark.biz/",
"tftp_url": "http://www.gusikowski.com/corrupti-sint-ut-quas-officiis-aliquid-tenetur",
"license": "neque",
"gpxe": "Dignissimos nulla laudantium at corrupti.",
"disk_layout": "Doloremque at eos maiores libero sunt consequatur.",
"packages": "Quibusdam quaerat sed amet.",
"post_installation": "Excepturi et aut nihil autem minus.",
"first_boot": "Reprehenderit veniam repudiandae repellat ut omnis sit.",
"extras": "Voluptas quam ea doloribus minima.",
"timezone": "Europe/Sarajevo",
"language": "bm",
"family": "",
"is_windows": false,
"is_rescue": false
},
{
"id": 46,
"template_id": 46,
"name": "repudiandae",
"tags": [
"non",
"ducimus",
"dignissimos",
"adipisci",
"odio"
],
"architecture": "arm",
"cache_folder": "molestiae",
"mirror": "http://glover.com/iure-vel-temporibus-tempora-dignissimos-mollitia.html",
"edition": "ea",
"iso_url": "https://www.schmitt.com/aliquid-ut-et-placeat-architecto-architecto",
"tftp_url": "http://miller.com/quia-nemo-nemo-error-officiis-reprehenderit",
"license": "dicta",
"gpxe": "Voluptatibus laborum consequatur molestiae adipisci.",
"disk_layout": "Vel perspiciatis ut reiciendis tenetur expedita asperiores.",
"packages": "Qui aliquid quae et deserunt fugit.",
"post_installation": "Commodi quo voluptatem ut corrupti nobis.",
"first_boot": "Nobis eligendi ullam reiciendis.",
"extras": "Fugiat tenetur ea quia nemo voluptas in.",
"timezone": "Asia/Bahrain",
"language": "io",
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List OS Addons
requires authentication
Returns a paginated list of OS addons available for the given service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/os/addons?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/addons'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/addons';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 14,
"name": "Dr. Lennie Hoeger II",
"description": "Excepturi est ducimus non tenetur in.",
"type": "postinstall",
"tag": "numquam ipsum",
"tags": [
"numquam",
"ipsum"
],
"data": "Fugiat voluptas quia iure architecto veritatis delectus est ut."
},
{
"id": 15,
"name": "Ryleigh Parker III",
"description": "In voluptatibus fugiat accusamus quia et quam.",
"type": "postinstall",
"tag": "eius numquam",
"tags": [
"eius",
"numquam"
],
"data": "Eos sed eius sunt repellendus repellat inventore."
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Install OS on Device
requires authentication
Initiates OS installation on a device assigned to the given service
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/os/install" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"template\": 12,
\"hostname\": \"server01.example.com\",
\"username\": \"admin\",
\"password\": \"secret123\",
\"root_password\": \"rootsecret\",
\"disk_addon\": 1,
\"extras\": [
1
],
\"ssh_keys\": [
11
]
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/install'
payload = {
"template": 12,
"hostname": "server01.example.com",
"username": "admin",
"password": "secret123",
"root_password": "rootsecret",
"disk_addon": 1,
"extras": [
1
],
"ssh_keys": [
11
]
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/install';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'template' => 12,
'hostname' => 'server01.example.com',
'username' => 'admin',
'password' => 'secret123',
'root_password' => 'rootsecret',
'disk_addon' => 1,
'extras' => [
1,
],
'ssh_keys' => [
11,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 9,
"device_id": 382,
"template_id": 47,
"message": "Quas dolorem sit dolores ipsa sunt ad repellat.",
"log": "",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Cancel OS Installation
requires authentication
Attempts to cancel the operating system installation process
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/os/cancel" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/cancel'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/cancel';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.OS Installation Information
requires authentication
Returns details about the current OS installation process
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/os/install/information" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/install/information'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/install/information';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 10,
"device_id": 383,
"template_id": 48,
"message": "Dolorem aut harum dolor autem omnis totam.",
"log": "",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Enable Rescue Mode
requires authentication
Initiates rescue mode for the device assigned to the given service
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/os/rescue/enable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/rescue/enable'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/rescue/enable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 11,
"device_id": 384,
"template_id": 49,
"message": "Neque dolorem aut eaque rerum non voluptatem non.",
"log": "",
"created_at": "2026-04-21 13:17:09",
"updated_at": "2026-04-21 13:17:09"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Rescue Mode Status
requires authentication
Returns the current rescue mode status
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/os/rescue/status" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/os/rescue/status'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/rescue/status';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"inRescueMode": false
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.IPMI
BMC Cold Reset
requires authentication
Sends a cold reset command to the BMC (Baseboard Management Controller) of the device associated with the given service. This action forces a full reboot of the BMC, which may temporarily interrupt device management features.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/ipmi/bmc-reset-cold" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/ipmi/bmc-reset-cold'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ipmi/bmc-reset-cold';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Start noVNC Session
requires authentication
Initiates a remote IPMI proxy session to the BMC of the device associated with the given service. The proxy allows web-based access to the BMC for remote management tasks like KVM, virtual media, or BIOS configuration.
If a session cannot be established, an error with logs may be returned for debugging purposes.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/ipmi/novnc-connect" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/ipmi/novnc-connect'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ipmi/novnc-connect';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 6,
"device_id": 392,
"url": "https://192.168.203.150/client/console/15563/gBhweXrV/396dfdf56c2eff2b875e6b2ed9ee1a9bd348ab28",
"status": 1,
"message": "Ad et optio laboriosam ut."
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show IPMI console session information
Retrieves session-related data for an active IPMI proxy session
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/ipmi/console/information" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"password\": \"3bf5By\",
\"port\": 5901,
\"token\": \"1784360e52abb6d874b92747ea9df6fabde33a20\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/ipmi/console/information'
payload = {
"password": "3bf5By",
"port": 5901,
"token": "1784360e52abb6d874b92747ea9df6fabde33a20"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/ipmi/console/information';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'password' => '3bf5By',
'port' => 5901,
'token' => '1784360e52abb6d874b92747ea9df6fabde33a20',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"ipmi_username": "ipmi_username",
"ipmi_password": "ipmi_password",
"disable_login_buttons": "0"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update IPMI session activity
Updates the updated_at timestamp of an active IPMI proxy session.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/ipmi/console/activity" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"password\": \"3bf5By\",
\"port\": 5901,
\"token\": \"1784360e52abb6d874b92747ea9df6fabde33a20\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/ipmi/console/activity'
payload = {
"password": "3bf5By",
"port": 5901,
"token": "1784360e52abb6d874b92747ea9df6fabde33a20"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/ipmi/console/activity';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'password' => '3bf5By',
'port' => 5901,
'token' => '1784360e52abb6d874b92747ea9df6fabde33a20',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "2025-10-21 15:06:20",
"data": null
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Close IPMI session
Terminates the IPMI proxy session. This is typically used when the user exits the remote console.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/ipmi/console/close" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"password\": \"3bf5By\",
\"port\": 5901,
\"token\": \"1784360e52abb6d874b92747ea9df6fabde33a20\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/ipmi/console/close'
payload = {
"password": "3bf5By",
"port": 5901,
"token": "1784360e52abb6d874b92747ea9df6fabde33a20"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/ipmi/console/close';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'password' => '3bf5By',
'port' => 5901,
'token' => '1784360e52abb6d874b92747ea9df6fabde33a20',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": null
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Two-Factor Authentication
Enable two-factor authentication
requires authentication
Initializes the selected 2FA module for the logged-in client and returns configuration data such as a QR code and secret needed to complete setup.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/two-factor/enable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"module_name\": \"Totp\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/two-factor/enable'
payload = {
"module_name": "Totp"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/two-factor/enable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'module_name' => 'Totp',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"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"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Disable two-factor authentication
requires authentication
Validates the user's password and, if correct, disables 2FA and removes any stored configuration.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/two-factor/disable" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"password\": \"user_current_password\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/two-factor/disable'
payload = {
"password": "user_current_password"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/two-factor/disable';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'password' => 'user_current_password',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "Two-factor authentication has been disabled successfully.",
"data": null
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store and verify 2FA configuration
requires authentication
Verifies the provided 2FA code and secret, and stores the configuration if verification succeeds. Also returns a backup code for account recovery.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/two-factor/store" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"module_name\": \"Totp\",
\"configuration\": {
\"code\": \"123456\",
\"secret_word\": \"JBSWY3DPEHPK3PXP\"
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/two-factor/store'
payload = {
"module_name": "Totp",
"configuration": {
"code": "123456",
"secret_word": "JBSWY3DPEHPK3PXP"
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/two-factor/store';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'module_name' => 'Totp',
'configuration' => [
'code' => '123456',
'secret_word' => 'JBSWY3DPEHPK3PXP',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"backup_code": "Wsg4Q 1ieF9 Rw6ID DIBrb"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Validate the second-factor authentication code after login
requires authentication
Verifies the submitted 2FA code using the user's default 2FA module. On success, marks the session as 2FA-authenticated.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/two-factor/validate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"configuration\": {
\"code\": \"123456\"
}
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/two-factor/validate'
payload = {
"configuration": {
"code": "123456"
}
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/two-factor/validate';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'configuration' => [
'code' => '123456',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Log in using a backup 2FA code
requires authentication
Validates the backup code stored during 2FA setup and marks the session as verified.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/two-factor/backup-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"code\": \"MY-BACKUP-CODE-123\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/two-factor/backup-code'
payload = {
"code": "MY-BACKUP-CODE-123"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/two-factor/backup-code';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'code' => 'MY-BACKUP-CODE-123',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"backup_code": "Wsg4Q 1ieF9 Rw6ID DIBrb"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.IP Address Management
List of IP addresses
requires authentication
This endpoint returns a paginated collection of IP addresses associated with the specified service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/ipaddresses?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=value" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'value',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'value',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 265,
"item_id": 38,
"value": "200.94.209.231",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update IP address description
requires authentication
Updates the description of an IP address entity associated with the device assigned to the specified service.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/ipaddresses/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"description\": \"Primary IP for web server\",
\"ip_address\": \"192.168.56.1\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses/456'
payload = {
"description": "Primary IP for web server",
"ip_address": "192.168.56.1"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses/456';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'description' => 'Primary IP for web server',
'ip_address' => '192.168.56.1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List of subnets
requires authentication
This endpoint returns a paginated collection of subnets associated with the specified service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=pool" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/subnets'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'pool',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/subnets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'pool',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 4,
"subnet": "142.233.218.0/24",
"pool": "142.233.218.0",
"mask": 24,
"gateway": null,
"type": "ipv4"
},
{
"id": 5,
"subnet": "105.177.22.0/24",
"pool": "105.177.22.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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.DNS Management
List rDNS records
requires authentication
This endpoint returns a paginated list of reverse DNS (rDNS) entries associated with the device assigned to the specified service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/123/rdns?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/rdns'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/rdns';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 1,
"device_id": 399,
"user_id": 1041,
"server_id": 1,
"ip": "30.195.44.63",
"from": "bernier.com",
"name": "jerde.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:15",
"updated_at": "2026-04-21 13:17:15"
},
{
"id": 2,
"device_id": 400,
"user_id": 1049,
"server_id": 2,
"ip": "157.252.126.66",
"from": "koch.com",
"name": "schroeder.com",
"ttl": "3600",
"created_at": "2026-04-21 13:17:16",
"updated_at": "2026-04-21 13:17:16"
}
],
"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
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create rDNS record
requires authentication
Stores a new reverse DNS (rDNS) entry for the device assigned to the given service.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/rdns" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ip\": \"192.168.1.1\",
\"rdata\": \"example.mydomain.com\",
\"ttl\": 3600
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/rdns'
payload = {
"ip": "192.168.1.1",
"rdata": "example.mydomain.com",
"ttl": 3600
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/rdns';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'ip' => '192.168.1.1',
'rdata' => 'example.mydomain.com',
'ttl' => 3600,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update rDNS record
requires authentication
Updates an existing reverse DNS (rDNS) record.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/client/services/123/rdns/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"rdata\": \"updated.example.net\",
\"ttl\": 3600
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/rdns/456'
payload = {
"rdata": "updated.example.net",
"ttl": 3600
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/rdns/456';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'rdata' => 'updated.example.net',
'ttl' => 3600,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete rDNS record
requires authentication
Deletes a reverse DNS (rDNS) record that belongs to the device assigned to the specified service.
Example request:
curl --request DELETE \
"https://your-easydcim.com/api/v3/client/services/123/rdns/456" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/123/rdns/456'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/rdns/456';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success"
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"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."
}
Example response (404, Not Found):
{
"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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Endpoints
GET api/v3/health
requires authentication
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/health" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/health'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/health';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.