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": 2706,
"app_id": null,
"name": "Morar PLC",
"address": "7688 Margarett Brooks\nWindlerview, AR 54009",
"city": "East Arvilla",
"state": "New Hampshire",
"description": "Quas ut omnis doloremque non. Aut nisi illum amet. Cupiditate porro inventore non debitis nihil.",
"notes": "Nihil qui voluptate dolorum voluptates. Qui alias minus mollitia et. Sed consectetur sed suscipit ipsa. Dolor saepe nisi fugiat non ipsa nemo.",
"emergency": "0",
"phone": "330-615-1568",
"flag": "Germany.png",
"created_at": "2026-06-03 08:49:45",
"updated_at": "2026-06-03 08:49:45"
},
{
"id": 2707,
"app_id": null,
"name": "Stroman-Buckridge",
"address": "684 Moore Burgs Suite 213\nWest Sierraside, PA 84152",
"city": "Gerlachborough",
"state": "Massachusetts",
"description": "Voluptas et asperiores eos voluptates qui blanditiis pariatur. Ut possimus sit eaque molestiae et. Vero beatae libero vero omnis occaecati qui eum non.",
"notes": "Non fugiat qui et qui magni numquam dicta. Doloribus enim perspiciatis consequatur quia voluptatem voluptas. Sit id molestiae dolore rerum. Dicta qui iure dolorem.",
"emergency": "1",
"phone": "+1-484-715-9323",
"flag": "Canada.png",
"created_at": "2026-06-03 08:49:46",
"updated_at": "2026-06-03 08:49:46"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 2708,
"app_id": null,
"name": "Shields-Jacobi",
"address": "64489 Ladarius Turnpike\nEast Andyview, AR 69194-0467",
"city": "South Lynnside",
"state": "Oregon",
"description": "Officia fuga id est. Et quas error esse consequatur. Veritatis quod est optio labore.",
"notes": "Asperiores nihil aut dolorem modi pariatur. Cupiditate voluptas aut minus qui laudantium. Qui rerum odio vel atque quasi molestias sed. Et suscipit quia consequatur necessitatibus.",
"emergency": "0",
"phone": "+1.984.788.4871",
"flag": "Germany.png",
"created_at": "2026-06-03 08:49:46",
"updated_at": "2026-06-03 08:49:46"
}
}
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": 2709,
"app_id": null,
"name": "Schneider-Kassulke",
"address": "33499 Ada Plaza Suite 454\nJoechester, FL 05332-3607",
"city": "New Mayra",
"state": "Maine",
"description": "Est dolorum possimus placeat nulla ducimus odio. Quam maiores quibusdam ducimus velit voluptatem vel. Dolore qui ducimus est quisquam aut tempore et tempore. Architecto quia et quos voluptas ut dolorem.",
"notes": "Autem molestiae est odit ut magni. Magni ab molestias excepturi sed. Harum consequatur exercitationem velit autem eaque. Perferendis maiores commodi eum provident voluptas.",
"emergency": "0",
"phone": "(949) 965-4327",
"flag": "Canada.png",
"created_at": "2026-06-03 08:49:46",
"updated_at": "2026-06-03 08:49:46"
}
}
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": 2710,
"app_id": null,
"name": "Schiller, Mayer and Thiel",
"address": "65006 Dietrich Course Suite 525\nWunschchester, UT 06864-9561",
"city": "Bridgettemouth",
"state": "Arkansas",
"description": "Molestiae beatae sint quia ut et eaque voluptate. Est nihil ullam aut et et delectus. Aut molestias voluptatem earum sed modi laboriosam non eligendi.",
"notes": "Accusantium magnam iusto aperiam blanditiis. Aperiam sunt aliquam quia sed aut aut enim. Quia est sunt a unde voluptas perferendis id. Officia incidunt reprehenderit pariatur inventore rerum.",
"emergency": "0",
"phone": "+1-930-906-2967",
"flag": "UK.png",
"created_at": "2026-06-03 08:49:47",
"updated_at": "2026-06-03 08:49: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.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": 564,
"name": "sed",
"floor_id": 528,
"location_id": 2711,
"description": "Aspernatur voluptatem ratione magni mollitia.",
"room": "rem",
"units_number": 66,
"weight": 117,
"speed": 10,
"manager_id": 4909,
"location": {
"id": 2711,
"app_id": null,
"name": "Kreiger Ltd",
"address": "7704 Cummings Valleys Apt. 415\nConnburgh, SD 09239-7367",
"city": "Quigleyview",
"state": "New Mexico",
"description": "Rerum ex quia id quibusdam repellat libero ut. Sequi perspiciatis vel sunt earum eius eum. Delectus doloremque voluptatibus sit corrupti.",
"notes": "Sed repellat fugiat libero reprehenderit odit quisquam sint. Qui temporibus nulla sequi porro.",
"emergency": "1",
"phone": "(920) 756-2443",
"flag": "Germany.png",
"created_at": "2026-06-03 08:49:47",
"updated_at": "2026-06-03 08:49:47"
},
"floor": {
"id": 528,
"name": "eos",
"number": 96,
"rows": 9,
"columns": 9,
"racks": [
{
"id": 564,
"name": "sed"
}
],
"created_at": "2026-06-03 08:49:48",
"updated_at": "2026-06-03 08:49:48"
},
"manager": {
"id": 4909,
"username": "jovany.bode",
"email": "[email protected]",
"name": "Adolfo Hegmann",
"firstname": "Adolfo",
"lastname": "Hegmann",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/271c271630b09d718021a190ddd0f2c3?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/271c271630b09d718021a190ddd0f2c3?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-06-03 08:49:48",
"updated_at": "2026-06-03 08:49:48"
},
{
"id": 565,
"name": "qui",
"floor_id": 529,
"location_id": 2713,
"description": "Voluptates qui nam sed hic.",
"room": "culpa",
"units_number": 8,
"weight": 141,
"speed": 1000,
"manager_id": 4912,
"location": {
"id": 2713,
"app_id": null,
"name": "Becker Ltd",
"address": "4852 Rigoberto Common Apt. 701\nEast Tyreekburgh, DE 80498-9069",
"city": "South Tomasstad",
"state": "Wyoming",
"description": "Nulla a voluptates unde. Sit nulla adipisci culpa totam sed. Ad enim qui assumenda iusto. Adipisci occaecati sunt voluptate quisquam adipisci.",
"notes": "Inventore pariatur qui voluptate aperiam. Totam aperiam esse velit nulla quis numquam.",
"emergency": "1",
"phone": "(360) 695-7332",
"flag": "Canada.png",
"created_at": "2026-06-03 08:49:48",
"updated_at": "2026-06-03 08:49:48"
},
"floor": {
"id": 529,
"name": "tempora",
"number": 12,
"rows": 3,
"columns": 6,
"racks": [
{
"id": 565,
"name": "qui"
}
],
"created_at": "2026-06-03 08:49:48",
"updated_at": "2026-06-03 08:49:48"
},
"manager": {
"id": 4912,
"username": "gwisoky",
"email": "[email protected]",
"name": "Joel Harvey",
"firstname": "Joel",
"lastname": "Harvey",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/862ae4dff11204d565b8dd04aa359e72?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/862ae4dff11204d565b8dd04aa359e72?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-06-03 08:49:49",
"updated_at": "2026-06-03 08:49:49"
}
],
"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": 566,
"name": "voluptatem",
"floor_id": 530,
"location_id": 2715,
"description": "Doloribus est consequatur aspernatur sapiente repellat.",
"room": "nisi",
"units_number": 63,
"weight": 133,
"speed": 1000,
"manager_id": 4915,
"location": {
"id": 2715,
"app_id": null,
"name": "Reichert, Ullrich and Armstrong",
"address": "32024 Leonel Dam\nChamplinport, OR 84236-6815",
"city": "New Tryciaborough",
"state": "West Virginia",
"description": "Optio ut deleniti et laboriosam possimus et. Enim aspernatur sed animi natus qui tenetur quo consequuntur. Animi vel eaque consequatur rerum.",
"notes": "Aspernatur sed repellat et soluta excepturi eligendi magnam. Tempora sed illum adipisci molestiae aut molestias error labore. Pariatur quia autem est quibusdam necessitatibus molestiae.",
"emergency": "1",
"phone": "415.925.5485",
"flag": "UK.png",
"created_at": "2026-06-03 08:49:49",
"updated_at": "2026-06-03 08:49:49"
},
"floor": {
"id": 530,
"name": "sit",
"number": 43,
"rows": 7,
"columns": 9,
"racks": [
{
"id": 566,
"name": "voluptatem"
}
],
"created_at": "2026-06-03 08:49:50",
"updated_at": "2026-06-03 08:49:50"
},
"manager": {
"id": 4915,
"username": "grussel",
"email": "[email protected]",
"name": "Oral Farrell",
"firstname": "Oral",
"lastname": "Farrell",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/213a7b99dc202ce88680cc292928f46e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/213a7b99dc202ce88680cc292928f46e?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-06-03 08:49:50",
"updated_at": "2026-06-03 08:49:50"
}
}
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": 567,
"name": "quia",
"floor_id": 531,
"location_id": 2717,
"description": "Repudiandae velit voluptates odit earum itaque et unde.",
"room": "non",
"units_number": 34,
"weight": 60,
"speed": 100,
"manager_id": 4918,
"location": {
"id": 2717,
"app_id": null,
"name": "Dibbert-Walker",
"address": "4457 Judy View\nNew Mckaylamouth, NH 21932",
"city": "Arturoton",
"state": "Alaska",
"description": "Ullam distinctio nemo alias tempora necessitatibus. Sint amet neque assumenda et laborum. Et quaerat sint aut aut ratione minima iusto. Qui dolorem praesentium delectus autem ipsam.",
"notes": "Explicabo quasi voluptatibus aut adipisci. Quod quas harum quia voluptatum. Autem optio non quisquam doloribus non. Numquam id distinctio rerum et reprehenderit repellendus.",
"emergency": "1",
"phone": "1-661-227-3542",
"flag": "Germany.png",
"created_at": "2026-06-03 08:49:50",
"updated_at": "2026-06-03 08:49:50"
},
"floor": {
"id": 531,
"name": "voluptatem",
"number": 63,
"rows": 6,
"columns": 9,
"racks": [
{
"id": 567,
"name": "quia"
}
],
"created_at": "2026-06-03 08:49:51",
"updated_at": "2026-06-03 08:49:51"
},
"manager": {
"id": 4918,
"username": "kattie.stark",
"email": "[email protected]",
"name": "Toby Dietrich",
"firstname": "Toby",
"lastname": "Dietrich",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/8c8fe6f7ee71dce45364d9efd93a2e9a?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/8c8fe6f7ee71dce45364d9efd93a2e9a?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-06-03 08:49:51",
"updated_at": "2026-06-03 08:49:51"
}
}
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": 568,
"name": "quasi",
"floor_id": 532,
"location_id": 2719,
"description": "Quibusdam et est dolores voluptatibus.",
"room": "voluptatem",
"units_number": 15,
"weight": 180,
"speed": 1000,
"manager_id": 4921,
"location": {
"id": 2719,
"app_id": null,
"name": "Prosacco and Sons",
"address": "732 Crist Heights Apt. 764\nSouth Marjolaineborough, SD 61164",
"city": "South Neha",
"state": "Vermont",
"description": "Sed quo sequi tempore possimus. Voluptatibus similique ut optio sint consequatur molestiae. Commodi earum eaque voluptas molestiae provident perferendis quae. Perspiciatis similique non nam tempore odio ullam architecto.",
"notes": "Perferendis voluptatibus tempora tempore. Fugit optio ullam quo rerum ut repellendus in.",
"emergency": "1",
"phone": "+1-551-787-3588",
"flag": "USA.png",
"created_at": "2026-06-03 08:49:51",
"updated_at": "2026-06-03 08:49:51"
},
"floor": {
"id": 532,
"name": "in",
"number": 3,
"rows": 3,
"columns": 7,
"racks": [
{
"id": 568,
"name": "quasi"
}
],
"created_at": "2026-06-03 08:49:52",
"updated_at": "2026-06-03 08:49:52"
},
"manager": {
"id": 4921,
"username": "durgan.addison",
"email": "[email protected]",
"name": "Marianna Pfannerstill",
"firstname": "Marianna",
"lastname": "Pfannerstill",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/96082df9b7d5a8526026e9750e95696c?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/96082df9b7d5a8526026e9750e95696c?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-06-03 08:49:52",
"updated_at": "2026-06-03 08:49:52"
}
}
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": 533,
"name": "praesentium",
"number": 33,
"rows": 7,
"columns": 10,
"racks": [],
"created_at": "2026-06-03 08:49:52",
"updated_at": "2026-06-03 08:49:52"
},
{
"id": 534,
"name": "similique",
"number": 6,
"rows": 3,
"columns": 7,
"racks": [],
"created_at": "2026-06-03 08:49:53",
"updated_at": "2026-06-03 08:49:53"
}
],
"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": 535,
"name": "non",
"number": 66,
"rows": 5,
"columns": 9,
"racks": [],
"created_at": "2026-06-03 08:49:53",
"updated_at": "2026-06-03 08:49:53"
}
}
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": 536,
"name": "officia",
"number": 85,
"rows": 9,
"columns": 3,
"racks": [],
"created_at": "2026-06-03 08:49:54",
"updated_at": "2026-06-03 08:49:54"
}
}
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": 537,
"name": "laboriosam",
"number": 8,
"rows": 9,
"columns": 8,
"racks": [],
"created_at": "2026-06-03 08:49:54",
"updated_at": "2026-06-03 08:49:54"
}
}
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": 1377,
"name": "sunt",
"label": "modi",
"type_id": 1787,
"type": {
"id": 1787,
"name": "eaque"
},
"location_id": 2726,
"status": "in_use",
"description": "Ad et similique et nemo quaerat eius.",
"is_part": false,
"mountable": true,
"manufacturer": "Becker-Gutkowski",
"position": "sed",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/00ddaa?text=ut",
"data_ports": 7,
"serialnumber1": "77b2cded-b26e-333e-91ab-d2da385a55ba",
"serialnumber2": "1c0f1459-6189-3f17-991f-dd22a0ab3450",
"service_tag": "a1736a11-2164-371f-ad84-cc6dfbf6785e",
"comments": "Est quam laboriosam doloremque ut quibusdam. Asperiores provident iure voluptatem consectetur dolorem in. Qui facere rerum dignissimos pariatur quia quod.",
"notes": "Expedita enim et nam consequatur libero sint vero fugit. Quod fuga natus repudiandae aut quis neque et. Iure deleniti velit sit quia. Aut quia quasi ut aut voluptatum placeat quia.",
"purchase_date": "2024-11-16",
"warranty_months": 35,
"warranty_info": "Officiis vel est totam maiores eius sed quis et.",
"function": "vel",
"maintenance_instruction": "Veniam quasi mollitia debitis velit. Qui accusantium vel consequuntur saepe velit. Culpa ab qui quia optio.",
"origin": "Mauritania",
"buy_price": 392.01,
"appdata": "a:1:{s:3:\"key\";s:11:\"consectetur\";}",
"fields_data": "a:1:{s:5:\"field\";s:2:\"et\";}",
"parts_data": "a:1:{s:4:\"part\";s:9:\"explicabo\";}",
"created_at": "2026-06-03T06:49:54.000000Z",
"updated_at": "2026-06-03T06:49:54.000000Z"
},
{
"id": 1378,
"name": "nesciunt",
"label": "error",
"type_id": 1788,
"type": {
"id": 1788,
"name": "dolores"
},
"location_id": 2727,
"status": "available",
"description": "Et beatae aliquam quae deleniti occaecati minus.",
"is_part": false,
"mountable": true,
"manufacturer": "Anderson, Lang and Kuhic",
"position": "eius",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/0055ff?text=aliquid",
"data_ports": 7,
"serialnumber1": "efc630fa-5bee-3c40-974d-09f38d5923f5",
"serialnumber2": "8f30d1ff-948e-3f99-b0ae-9b585274d938",
"service_tag": "ea6bd4e6-3bc4-3f78-a5ab-54614f4d9d2d",
"comments": "Unde nobis rerum est repudiandae sit omnis autem. Unde est sed ducimus fugit maxime.",
"notes": "Omnis culpa et quis amet quia. Sit harum enim vitae quos odio voluptatem. Sit doloribus dolore nam pariatur quis incidunt fugit quod.",
"purchase_date": "2022-04-28",
"warranty_months": 28,
"warranty_info": "Itaque corrupti sed et porro.",
"function": "dolorem",
"maintenance_instruction": "Earum est explicabo sed aut. Magnam cum ut quis earum quaerat. Hic aperiam non ullam quidem et repellat quis. Maiores facere beatae ipsa assumenda quia non.",
"origin": "Papua New Guinea",
"buy_price": 503.11,
"appdata": "a:1:{s:3:\"key\";s:8:\"quisquam\";}",
"fields_data": "a:1:{s:5:\"field\";s:8:\"sapiente\";}",
"parts_data": "a:1:{s:4:\"part\";s:8:\"repellat\";}",
"created_at": "2026-06-03T06:49:55.000000Z",
"updated_at": "2026-06-03T06:49:55.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": 1379,
"name": "aliquam",
"label": "vel",
"type_id": 1789,
"type": {
"id": 1789,
"name": "et"
},
"location_id": 2728,
"status": "in_use",
"description": "Maxime distinctio ut reiciendis soluta qui voluptas.",
"is_part": false,
"mountable": true,
"manufacturer": "Considine, Prosacco and McDermott",
"position": "delectus",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/008833?text=enim",
"data_ports": 8,
"serialnumber1": "6ce32b3e-7b80-38fa-a849-51701ea844eb",
"serialnumber2": "9843de07-d333-3fcd-97cc-9ebe9afcded9",
"service_tag": "60335df3-99b3-3884-aefc-27912e1a7c53",
"comments": "Tempora asperiores consequatur quia voluptas modi animi qui distinctio. Harum est vero quos consequatur. Quo voluptatem magnam consequuntur ea saepe optio qui deserunt.",
"notes": "Deleniti dolor eos accusantium modi quas et. Temporibus ut adipisci accusantium perferendis atque. Officia non ea earum et. Deserunt consequatur eaque labore necessitatibus.",
"purchase_date": "1987-11-23",
"warranty_months": 12,
"warranty_info": "Explicabo incidunt beatae repellendus ut.",
"function": "reiciendis",
"maintenance_instruction": "Enim sunt expedita et necessitatibus nam laudantium. Commodi iure et consequuntur et labore. Voluptas minus aspernatur totam ratione nobis et.",
"origin": "Kiribati",
"buy_price": 337.29,
"appdata": "a:1:{s:3:\"key\";s:6:\"maxime\";}",
"fields_data": "a:1:{s:5:\"field\";s:8:\"sapiente\";}",
"parts_data": "a:1:{s:4:\"part\";s:8:\"voluptas\";}",
"created_at": "2026-06-03T06:49:55.000000Z",
"updated_at": "2026-06-03T06:49:55.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\": \"uarytn\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"qziywhfjedigown\",
\"notes\": \"imnnvriqgifknysqaoezazjv\",
\"purchase_date\": \"2026-06-03T08:49:55\",
\"warranty_months\": 36,
\"warranty_info\": \"vbrzjwcxvhwzihb\",
\"function\": \"xu\",
\"maintenance_instruction\": \"gdgqusoknz\",
\"origin\": \"vn\",
\"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": "uarytn",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "qziywhfjedigown",
"notes": "imnnvriqgifknysqaoezazjv",
"purchase_date": "2026-06-03T08:49:55",
"warranty_months": 36,
"warranty_info": "vbrzjwcxvhwzihb",
"function": "xu",
"maintenance_instruction": "gdgqusoknz",
"origin": "vn",
"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' => 'uarytn',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'qziywhfjedigown',
'notes' => 'imnnvriqgifknysqaoezazjv',
'purchase_date' => '2026-06-03T08:49:55',
'warranty_months' => 36,
'warranty_info' => 'vbrzjwcxvhwzihb',
'function' => 'xu',
'maintenance_instruction' => 'gdgqusoknz',
'origin' => 'vn',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 1380,
"name": "voluptas",
"label": "laborum",
"type_id": 1790,
"type": {
"id": 1790,
"name": "dolores"
},
"location_id": 2729,
"status": "in_use",
"description": "Atque optio consequatur et.",
"is_part": true,
"mountable": false,
"manufacturer": "Kreiger, Connelly and Zieme",
"position": "asperiores",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/00ffbb?text=vel",
"data_ports": 3,
"serialnumber1": "aa32fd34-a93d-32a5-9898-0bea7ac06937",
"serialnumber2": "f56c48f3-43ec-3d41-bd3b-c21c28986b29",
"service_tag": "5bf8c1df-3847-30bf-a4a7-562748a5f2cf",
"comments": "Expedita quis aspernatur ipsa consectetur. Dicta nesciunt autem omnis qui ex. Dolores dolorem odit qui quis doloribus ipsam.",
"notes": "Itaque nulla temporibus at quia. Rerum modi ducimus cum aliquid aut. Nesciunt sed aut qui fugit. Et enim suscipit repellendus velit.",
"purchase_date": "2014-09-26",
"warranty_months": 17,
"warranty_info": "Provident ut autem totam dignissimos.",
"function": "ab",
"maintenance_instruction": "Ut voluptatem unde ad doloremque officiis quo voluptates quo. Aut saepe optio dicta eos. Alias rerum est et excepturi.",
"origin": "Argentina",
"buy_price": 193.16,
"appdata": "a:1:{s:3:\"key\";s:10:\"temporibus\";}",
"fields_data": "a:1:{s:5:\"field\";s:6:\"fugiat\";}",
"parts_data": "a:1:{s:4:\"part\";s:2:\"id\";}",
"created_at": "2026-06-03T06:49:55.000000Z",
"updated_at": "2026-06-03T06:49:55.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\": \"ylvqk\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"dudbefbgwlvedbcgptqxhg\",
\"notes\": \"pzmmkdxj\",
\"purchase_date\": \"2026-06-03T08:49:55\",
\"warranty_months\": 36,
\"warranty_info\": \"fuuuiqegrhhzjlhvhjh\",
\"function\": \"uqhmzi\",
\"maintenance_instruction\": \"ohaldlxhojnlgyu\",
\"origin\": \"qjbkgcfq\",
\"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": "ylvqk",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "dudbefbgwlvedbcgptqxhg",
"notes": "pzmmkdxj",
"purchase_date": "2026-06-03T08:49:55",
"warranty_months": 36,
"warranty_info": "fuuuiqegrhhzjlhvhjh",
"function": "uqhmzi",
"maintenance_instruction": "ohaldlxhojnlgyu",
"origin": "qjbkgcfq",
"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' => 'ylvqk',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'dudbefbgwlvedbcgptqxhg',
'notes' => 'pzmmkdxj',
'purchase_date' => '2026-06-03T08:49:55',
'warranty_months' => 36,
'warranty_info' => 'fuuuiqegrhhzjlhvhjh',
'function' => 'uqhmzi',
'maintenance_instruction' => 'ohaldlxhojnlgyu',
'origin' => 'qjbkgcfq',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 1381,
"name": "sed",
"label": "aut",
"type_id": 1791,
"type": {
"id": 1791,
"name": "nam"
},
"location_id": 2730,
"status": "available",
"description": "Voluptas nam occaecati delectus eius rerum aliquid sed.",
"is_part": true,
"mountable": false,
"manufacturer": "Schroeder-Cartwright",
"position": "alias",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/007799?text=natus",
"data_ports": 4,
"serialnumber1": "5884bf05-af8a-39b5-afe5-7819d35edbb5",
"serialnumber2": "89410fe9-3df4-3aff-88bb-b68be390060e",
"service_tag": "cf042856-dba4-3c1a-b14e-5547c1923280",
"comments": "Unde officia consequatur earum quis similique illum neque. Hic in culpa neque dignissimos eaque quia ut.",
"notes": "Qui natus cum voluptatum ipsam alias et blanditiis. Assumenda omnis officia officia excepturi dolores. Harum delectus omnis porro ut at voluptatem. Et eveniet delectus vero consequatur quisquam.",
"purchase_date": "2025-12-05",
"warranty_months": 15,
"warranty_info": "Eveniet est aspernatur qui dolor ullam quam culpa.",
"function": "laborum",
"maintenance_instruction": "Illo sint dolor fugiat velit. Dolorem amet eligendi magnam tenetur voluptas. Aliquid quo et cupiditate et enim.",
"origin": "Libyan Arab Jamahiriya",
"buy_price": 837.09,
"appdata": "a:1:{s:3:\"key\";s:8:\"corporis\";}",
"fields_data": "a:1:{s:5:\"field\";s:3:\"qui\";}",
"parts_data": "a:1:{s:4:\"part\";s:8:\"expedita\";}",
"created_at": "2026-06-03T06:49:56.000000Z",
"updated_at": "2026-06-03T06:49:56.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": 4932,
"username": "hickle.emil",
"email": "[email protected]",
"name": "Damon Cormier",
"firstname": "Damon",
"lastname": "Cormier",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/4e22627c7bfd26f3750067c363cff0c2?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/4e22627c7bfd26f3750067c363cff0c2?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": 4933,
"username": "icremin",
"email": "[email protected]",
"name": "Sonya Ritchie",
"firstname": "Sonya",
"lastname": "Ritchie",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/5c471481aee7082f599aac81393859d8?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/5c471481aee7082f599aac81393859d8?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": 4934,
"username": "jacinthe48",
"email": "[email protected]",
"name": "Juana Lehner",
"firstname": "Juana",
"lastname": "Lehner",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/c784145450215922afc32a86d2d04d84?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/c784145450215922afc32a86d2d04d84?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": 4935,
"username": "santina45",
"email": "[email protected]",
"name": "Julianne Labadie",
"firstname": "Julianne",
"lastname": "Labadie",
"devices": [],
"orders": [],
"gender": "0",
"avatar": "//www.gravatar.com/avatar/69e3629762beff3704e8d32f2e7cd743?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/69e3629762beff3704e8d32f2e7cd743?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": 4936,
"username": "issac.cole",
"email": "[email protected]",
"name": "Rhiannon Bernier",
"firstname": "Rhiannon",
"lastname": "Bernier",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/41a039534f6098f664023d0a96b0c70c?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/41a039534f6098f664023d0a96b0c70c?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": 4937,
"username": "warren11",
"email": "[email protected]",
"name": "Edgar Barrows",
"firstname": "Edgar",
"lastname": "Barrows",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/f8116b0d98cea35543f5044c441f0f8f?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/f8116b0d98cea35543f5044c441f0f8f?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\": [
11
],
\"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": [
11
],
"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' => [
11,
],
'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": 3336,
"name": null,
"description": "Eum sapiente ut dicta aut accusantium ullam.",
"item_id": 958,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 19,
"port_index": 4,
"port_mode": "trunk",
"port_label": "eum",
"user_label": "hic",
"speed": "10000",
"high_speed": "10000",
"if_type": "193",
"physaddress": "4F:6F:0A:C6:4E:9D",
"pullable": 1,
"primary": 1,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 7033,
"ifOutUcastPkts": 6549,
"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-06-03 08:49:57",
"updated_at": "2026-06-03 08:49:57"
},
{
"id": 3337,
"name": null,
"description": "Adipisci eos est dolorem quo expedita unde.",
"item_id": 959,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 13,
"port_index": 92,
"port_mode": "access",
"port_label": "et",
"user_label": "modi",
"speed": "1000",
"high_speed": "1000",
"if_type": "127",
"physaddress": "08:88:28:12:84:1E",
"pullable": 0,
"primary": 1,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 9938,
"ifOutUcastPkts": 5017,
"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-06-03 08:49:58",
"updated_at": "2026-06-03 08:49: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/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.Show port
requires authentication
Display detailed information about a single 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": 3338,
"name": null,
"description": "Rerum eius fuga vel molestiae facilis molestiae aperiam.",
"item": {
"id": 960,
"name": null,
"label": "et",
"type_id": 1796,
"location_id": 2736,
"status": "available",
"description": "Nam non minus nobis ab quia voluptas id earum.",
"is_part": false,
"mountable": true,
"manufacturer": "Lockman-Block",
"position": null,
"size": 8,
"image": null,
"data_ports": 0,
"serialnumber1": "SN382VV",
"serialnumber2": null,
"service_tag": "ST092VY",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:49:58.000000Z",
"updated_at": "2026-06-03T06:49:58.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 8,
"port_index": 52,
"port_mode": "access",
"port_label": "dignissimos",
"user_label": "ipsam",
"speed": "10000",
"high_speed": "10000",
"if_type": "41",
"physaddress": "7E:C2:A5:18:33:E4",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 2697,
"ifOutUcastPkts": 7002,
"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-06-03 08:49:59",
"updated_at": "2026-06-03 08:49: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 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": 3339,
"name": null,
"description": "Assumenda velit labore quia ullam libero animi ut.",
"item": {
"id": 961,
"name": null,
"label": "illo",
"type_id": 1798,
"location_id": 2738,
"status": "available",
"description": "Quis minima rerum id eum modi delectus.",
"is_part": false,
"mountable": true,
"manufacturer": "Hackett, Brakus and Baumbach",
"position": null,
"size": 3,
"image": null,
"data_ports": 0,
"serialnumber1": "SN280NX",
"serialnumber2": null,
"service_tag": "ST737AA",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:49:59.000000Z",
"updated_at": "2026-06-03T06:49:59.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 3,
"port_index": 60,
"port_mode": "trunk",
"port_label": "sequi",
"user_label": "excepturi",
"speed": "100",
"high_speed": "10000",
"if_type": "36",
"physaddress": "5B:2B:90:C1:07:D3",
"pullable": 1,
"primary": 1,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 4749,
"ifOutUcastPkts": 2785,
"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-06-03 08:50:00",
"updated_at": "2026-06-03 08:50: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.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": 3340,
"name": null,
"description": "Molestiae praesentium praesentium est architecto commodi.",
"item": {
"id": 962,
"name": null,
"label": "reprehenderit",
"type_id": 1800,
"location_id": 2740,
"status": "available",
"description": "Molestiae illo ratione possimus vero rerum ut.",
"is_part": false,
"mountable": true,
"manufacturer": "Dickinson and Sons",
"position": null,
"size": 9,
"image": null,
"data_ports": 0,
"serialnumber1": "SN733GL",
"serialnumber2": null,
"service_tag": "ST179LI",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:50:00.000000Z",
"updated_at": "2026-06-03T06:50:00.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 11,
"port_index": 56,
"port_mode": "access",
"port_label": "porro",
"user_label": "recusandae",
"speed": "100",
"high_speed": "1000",
"if_type": "131",
"physaddress": "6F:AF:B9:B1:CE:AD",
"pullable": 0,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 2487,
"ifOutUcastPkts": 631,
"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-06-03 08:50:01",
"updated_at": "2026-06-03 08:50:01"
}
}
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": 3341,
"name": null,
"description": "Officia quibusdam molestias voluptates placeat quasi possimus autem.",
"item": null,
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 47,
"port_index": 8,
"port_mode": "access",
"port_label": "consequuntur",
"user_label": "vero",
"speed": "10000",
"high_speed": "10000",
"if_type": "208",
"physaddress": "32:FE:F6:72:3D:B7",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 9541,
"ifOutUcastPkts": 8366,
"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-06-03 08:50:03",
"updated_at": "2026-06-03 08:50: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.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": 3342,
"name": null,
"description": "Sint rerum neque aut hic.",
"item": {
"id": 964,
"name": null,
"label": "qui",
"type_id": 1804,
"location_id": 2744,
"status": "available",
"description": "Atque error explicabo est blanditiis aliquid.",
"is_part": false,
"mountable": true,
"manufacturer": "Jacobson-Hickle",
"position": null,
"size": 3,
"image": null,
"data_ports": 0,
"serialnumber1": "SN727EO",
"serialnumber2": null,
"service_tag": "ST415PG",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:50:03.000000Z",
"updated_at": "2026-06-03T06:50:03.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 21,
"port_index": 100,
"port_mode": "trunk",
"port_label": "atque",
"user_label": "quis",
"speed": "100",
"high_speed": "1000",
"if_type": "109",
"physaddress": "87:55:F8:3F:B0:F6",
"pullable": 1,
"primary": 1,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 4870,
"ifOutUcastPkts": 8273,
"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-06-03 08:50:03",
"updated_at": "2026-06-03 08:50: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.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.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": 519,
"ordernumber": 931734,
"user_id": 4959,
"status": "pending",
"service_status": "suspended",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50:04"
},
{
"id": 520,
"ordernumber": 666315,
"user_id": 4960,
"status": "accepted",
"service_status": "provisioning",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50:04"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 521,
"ordernumber": 457889,
"user_id": 4961,
"status": "pending",
"service_status": "waiting",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50: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.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": 522,
"ordernumber": 278887,
"user_id": 4962,
"status": "pending",
"service_status": "terminated",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50: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.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": 523,
"ordernumber": 966972,
"user_id": 4963,
"status": "pending",
"service_status": "suspended",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50: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 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": 524,
"ordernumber": 635504,
"user_id": 4964,
"status": "accepted",
"service_status": "activated",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50: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.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": 525,
"ordernumber": 948126,
"user_id": 4965,
"status": "pending",
"service_status": "activated",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-06-03 08:50:04",
"updated_at": "2026-06-03 08:50: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.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\": \"Server\",
\"action\": \"unsuspend\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/orders/actions/list'
payload = {
"type": "Server",
"action": "unsuspend"
}
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' => 'Server',
'action' => 'unsuspend',
],
]
);
$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": 50,
"name": "Ms. Malika Koelpin MD",
"order": 9,
"parent_id": 966,
"child_id": 965,
"created_at": "2026-06-03 08:50:06",
"updated_at": "2026-06-03 08:50:06"
},
{
"id": 51,
"name": "Glenda Glover",
"order": 9,
"parent_id": 968,
"child_id": 967,
"created_at": "2026-06-03 08:50:08",
"updated_at": "2026-06-03 08:50:08"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 52,
"name": "Prof. Jeffrey Orn",
"order": 6,
"parent": {
"id": 970,
"label": "consequuntur",
"model": "qui",
"product_id": 0,
"model_id": 1407,
"parent_id": 0,
"type_id": 6,
"user_id": 4982,
"order_id": 0,
"location_id": 2756,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Jacobi-Senger",
"description": "Quaerat in ab quod sint est.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN407IR",
"serialnumber2": null,
"service_tag": "ST421LO",
"location": "Schowalter and Sons",
"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": null,
"created_at": "2026-06-03 08:50:10",
"updated_at": "2026-06-03 08:50: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.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": 53,
"name": "Ashlynn Heathcote",
"order": 5,
"parent": {
"id": 972,
"label": "accusamus",
"model": "non",
"product_id": 0,
"model_id": 1411,
"parent_id": 0,
"type_id": 6,
"user_id": 4988,
"order_id": 0,
"location_id": 2760,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Lesch Group",
"description": "Necessitatibus velit ut libero consequuntur voluptate blanditiis.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN439HB",
"serialnumber2": null,
"service_tag": "ST347VE",
"location": "Boehm Ltd",
"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": 971,
"label": "amet",
"model": "distinctio",
"product_id": 0,
"model_id": 1409,
"parent_id": 0,
"type_id": 1815,
"user_id": 4985,
"order_id": 0,
"location_id": 2760,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Carter-Christiansen",
"description": "Totam iste ad doloribus quia.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN943RG",
"serialnumber2": null,
"service_tag": "ST966EH",
"location": "Boehm Ltd",
"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-06-03 08:50:11",
"updated_at": "2026-06-03 08:50:11"
}
}
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": 54,
"name": "Prof. Shayne Fritsch",
"order": 5,
"parent": {
"id": 974,
"label": "similique",
"model": "nisi",
"product_id": 0,
"model_id": 1415,
"parent_id": 0,
"type_id": 6,
"user_id": 4994,
"order_id": 0,
"location_id": 2764,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Renner, Brekke and Yost",
"description": "Distinctio dolorem laudantium praesentium facilis enim.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN807OZ",
"serialnumber2": null,
"service_tag": "ST713UY",
"location": "Okuneva, Daugherty and Smitham",
"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": null,
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
}
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": 1821,
"name": "officia",
"description": "Id ipsa molestiae fugiat minus eligendi ea fugit consequatur.",
"hardware": 1,
"software": 0,
"predefined": 1,
"color": "teal",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
},
{
"id": 1822,
"name": "nobis",
"description": "Sunt aut ut aliquid aut accusamus.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "olive",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 1823,
"name": "cumque",
"description": "Est quibusdam culpa molestiae.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "black",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
}
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": 1824,
"name": "numquam",
"description": "Voluptas dolore rerum quis nihil.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "green",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
}
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": 1825,
"name": "eaque",
"description": "Qui est occaecati minima facere nulla voluptate modi.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "lime",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
}
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": 59,
"title": "Elijah Bechtelar"
},
{
"id": 60,
"title": "Corbin Pouros"
}
],
"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": 479,
"name": "ratione.ut.voluptatem",
"display_name": "Mr. Brando Torp Sr.",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
},
{
"id": 480,
"name": "rerum.et.aut",
"display_name": "Araceli Jerde",
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
}
]
}
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": 61,
"title": "Leo Walker",
"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": 62,
"title": "Geoffrey Abshire",
"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": 63,
"title": "Kirk Gorczany",
"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": 975,
"model_id": 1417,
"parent_id": 0,
"type_id": 1826,
"user_id": 4997,
"location_id": 2766,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"model": "cupiditate",
"manufacturer": "Bartell, Ankunding and Swift",
"serialnumber1": "SN924FN",
"serialnumber2": null,
"service_tag": "ST222PF",
"comments": null,
"label": "soluta",
"description": "Autem mollitia voluptas culpa occaecati error harum.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:13",
"updated_at": "2026-06-03 08:50:13"
},
{
"id": 976,
"model_id": 1419,
"parent_id": 0,
"type_id": 1828,
"user_id": 5000,
"location_id": 2768,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"model": "omnis",
"manufacturer": "Baumbach, White and Denesik",
"serialnumber1": "SN966SP",
"serialnumber2": null,
"service_tag": "ST565KR",
"comments": null,
"label": "ab",
"description": "Culpa nostrum voluptatem cumque dolores aut atque in vel.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:14",
"updated_at": "2026-06-03 08:50: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/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": 977,
"model": {
"id": 1421,
"name": "quis",
"label": null,
"type_id": 1830,
"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-06-03T06:50:16.000000Z",
"updated_at": "2026-06-03T06:50:16.000000Z"
},
"user": {
"id": 5003,
"username": "kuhlman.consuelo",
"email": "[email protected]",
"name": "Vena Reichert",
"firstname": "Vena",
"lastname": "Reichert",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/0a1a63f6143909796e9e1295e37f5e1e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/0a1a63f6143909796e9e1295e37f5e1e?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": 1830,
"name": "repudiandae",
"description": "Doloribus et hic est autem consequatur.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "aqua",
"created_at": "2026-06-03 08:50:15",
"updated_at": "2026-06-03 08:50:15"
},
"parent": null,
"location": {
"id": 2770,
"app_id": null,
"name": "Kshlerin, Kirlin and Blick",
"address": "2202 Moore Ramp\nNew Connie, AZ 30587-2215",
"city": "Port Libbie",
"state": "North Dakota",
"description": "Autem voluptas ut cupiditate amet omnis laborum. Impedit dolores nihil impedit cumque inventore rerum. Quia aut voluptatibus tempora eius ut. Magni deserunt odio omnis illo doloremque maiores. Animi aperiam aliquid et excepturi facere ipsam.",
"notes": "Nemo ea porro quis quia a rerum qui. Corporis repellendus autem esse iusto. Quae facilis qui qui blanditiis neque et nobis tempore.",
"emergency": "1",
"phone": "1-979-955-5711",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:16",
"updated_at": "2026-06-03 08:50:16"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "O'Conner Inc",
"serialnumber1": "SN555RV",
"serialnumber2": null,
"service_tag": "ST722DF",
"comments": null,
"label": "praesentium",
"description": "Distinctio accusamus quisquam cumque veniam sed soluta nihil.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:15",
"updated_at": "2026-06-03 08:50: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.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": 978,
"model": {
"id": 1423,
"name": "reiciendis",
"label": null,
"type_id": 1832,
"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-06-03T06:50:17.000000Z",
"updated_at": "2026-06-03T06:50:17.000000Z"
},
"user": {
"id": 5006,
"username": "schimmel.norwood",
"email": "[email protected]",
"name": "Doug Mante",
"firstname": "Doug",
"lastname": "Mante",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/efb0f4714c82326699af9f528d05fefa?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/efb0f4714c82326699af9f528d05fefa?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": 1832,
"name": "quia",
"description": "Nesciunt aut blanditiis ea amet non ratione.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "purple",
"created_at": "2026-06-03 08:50:16",
"updated_at": "2026-06-03 08:50:16"
},
"parent": null,
"location": {
"id": 2772,
"app_id": null,
"name": "Corwin PLC",
"address": "5791 Torphy Pines Suite 233\nNorth Carmineside, SD 32749",
"city": "West Augusttown",
"state": "Michigan",
"description": "Porro nobis ut in laboriosam rerum. Rerum sint consequuntur debitis a aut deserunt atque ut. Error sunt aut fuga laborum a. Pariatur molestiae aut et dolorem assumenda doloribus cupiditate ratione.",
"notes": "Soluta dolore maxime rem est. Perferendis corrupti autem ea veniam aut facilis similique. In eum suscipit in. Ut est beatae sit facilis voluptatem consequuntur.",
"emergency": "1",
"phone": "+1-361-607-0418",
"flag": "Germany.png",
"created_at": "2026-06-03 08:50:17",
"updated_at": "2026-06-03 08:50:17"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Botsford-Prosacco",
"serialnumber1": "SN109GX",
"serialnumber2": null,
"service_tag": "ST702RY",
"comments": null,
"label": "impedit",
"description": "Sequi omnis eum consequatur tempore repellendus accusamus.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:16",
"updated_at": "2026-06-03 08:50: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.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": 979,
"model": {
"id": 1425,
"name": "fugit",
"label": null,
"type_id": 1834,
"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-06-03T06:50:18.000000Z",
"updated_at": "2026-06-03T06:50:18.000000Z"
},
"user": {
"id": 5009,
"username": "maurice.walker",
"email": "[email protected]",
"name": "Wava Yost",
"firstname": "Wava",
"lastname": "Yost",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/0c45a26bb36ef4ff5fc6e19a65bffdc2?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/0c45a26bb36ef4ff5fc6e19a65bffdc2?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": 1834,
"name": "et",
"description": "Maiores qui sit voluptate.",
"hardware": 0,
"software": 0,
"predefined": 1,
"color": "fuchsia",
"created_at": "2026-06-03 08:50:17",
"updated_at": "2026-06-03 08:50:17"
},
"parent": null,
"location": {
"id": 2774,
"app_id": null,
"name": "Terry-Boyle",
"address": "421 Santos Stravenue Apt. 449\nPort Dena, WI 82137-6817",
"city": "Ernestinestad",
"state": "Idaho",
"description": "Velit vitae nam possimus rerum tenetur voluptas cum. Deleniti exercitationem soluta ea repellat. Optio cum rem et doloribus velit autem vitae. Natus quod facilis soluta inventore porro reprehenderit.",
"notes": "Natus atque est iste ipsam molestiae. Et quod recusandae modi eaque accusantium fugiat. Eveniet ullam tempora eligendi qui est. Magni voluptatum et aliquam quidem.",
"emergency": "0",
"phone": "+1.801.588.6282",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:18",
"updated_at": "2026-06-03 08:50:18"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Effertz, Bartoletti and Kerluke",
"serialnumber1": "SN177CJ",
"serialnumber2": null,
"service_tag": "ST808EN",
"comments": null,
"label": "sed",
"description": "Est dolor quam aspernatur ratione dolorem.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:17",
"updated_at": "2026-06-03 08:50: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.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": 980,
"model": {
"id": 1427,
"name": "et",
"label": null,
"type_id": 1836,
"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-06-03T06:50:19.000000Z",
"updated_at": "2026-06-03T06:50:19.000000Z"
},
"user": {
"id": 5012,
"username": "jermaine66",
"email": "[email protected]",
"name": "Rasheed Howe",
"firstname": "Rasheed",
"lastname": "Howe",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/d83b429b7fc4282c242c232cea9f8e1f?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/d83b429b7fc4282c242c232cea9f8e1f?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": 1836,
"name": "debitis",
"description": "Voluptatem quo rerum laborum iure accusantium.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "gray",
"created_at": "2026-06-03 08:50:18",
"updated_at": "2026-06-03 08:50:18"
},
"parent": null,
"location": {
"id": 2776,
"app_id": null,
"name": "Nicolas, Miller and Cronin",
"address": "207 Angelina Lakes Suite 013\nWest Lorenaberg, MI 52981",
"city": "Leuschkefurt",
"state": "New Hampshire",
"description": "Sint facere nisi voluptatem itaque cupiditate. Iure ad dolorum et voluptatibus neque illum iure. Earum aliquam vero laudantium beatae qui non. Quod in consequatur nulla nihil illo soluta.",
"notes": "Et maxime sed necessitatibus et possimus quia qui et. Ad beatae corporis laudantium et aut in. Dicta dolor omnis aut. Sint quae corporis nesciunt quia dolor iusto.",
"emergency": "0",
"phone": "+1 (283) 309-7517",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50:19"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Feeney Group",
"serialnumber1": "SN020DM",
"serialnumber2": null,
"service_tag": "ST308UW",
"comments": null,
"label": "eum",
"description": "Qui vitae dolores molestias suscipit.",
"purchase_date": "2025-06-03",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-06-03 08:50:18",
"updated_at": "2026-06-03 08:50: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 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": 151,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "porro.repudiandae.officiis",
"label": "Fanny Keebler",
"options": {
"quia facilis eveniet quas beatae": "quia facilis eveniet quas beatae"
},
"predefined": 0,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 0,
"encrypted": 1,
"additional_rules": [
"harum",
"doloribus",
"deserunt",
"modi",
"iure"
],
"order": 16,
"types": [],
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50:19"
},
{
"id": 152,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "veritatis.consequuntur.magnam",
"label": "Pearline Abbott",
"options": {
"occaecati cupiditate ullam voluptatum quasi": "occaecati cupiditate ullam voluptatum quasi"
},
"predefined": 1,
"hidden": 0,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 1,
"encrypted": 1,
"additional_rules": [
"et",
"dicta",
"commodi",
"modi",
"id"
],
"order": 71,
"types": [],
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50: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/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": 153,
"related_type": null,
"element": "textarea",
"group": "Base",
"slug": "nulla.iusto.sequi",
"label": "Maegan Graham",
"options": {
"dolor necessitatibus iure similique qui": "dolor necessitatibus iure similique qui"
},
"predefined": 0,
"hidden": 0,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"quo",
"animi",
"placeat",
"tempora",
"saepe"
],
"order": 78,
"values": [],
"types": [],
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50: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 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": 154,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "facilis.cumque.quia",
"label": "Dr. Justice Langworth II",
"options": {
"ut ea aperiam debitis cupiditate": "ut ea aperiam debitis cupiditate"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 1,
"additional_rules": [
"illo",
"et",
"doloremque",
"natus",
"laudantium"
],
"order": 61,
"values": [],
"types": [],
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50: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 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": 155,
"related_type": null,
"element": "textarea",
"group": "Base",
"slug": "eos.quia.rem",
"label": "Kristy Bogisich",
"options": {
"sit in dolor ut sed": "sit in dolor ut sed"
},
"predefined": 1,
"hidden": 0,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 0,
"encrypted": 0,
"additional_rules": [
"sit",
"ab",
"alias",
"sunt",
"odit"
],
"order": 87,
"values": [],
"types": [],
"created_at": "2026-06-03 08:50:19",
"updated_at": "2026-06-03 08:50: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 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.Power Ports
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": 431,
"name": "consequatur",
"description": "Tempora nihil sunt molestiae dolorum.",
"item_id": 981,
"colocation_id": 0,
"port_number": 20,
"port_label": "in",
"user_label": "voluptatum",
"outlet_state": "outletOn",
"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-06-03 08:50:19",
"updated_at": "2026-06-03 08:50:19"
},
{
"id": 432,
"name": "occaecati",
"description": "Eum quas reiciendis debitis facere voluptatem consequuntur.",
"item_id": 982,
"colocation_id": 0,
"port_number": 11,
"port_label": "sapiente",
"user_label": "dolores",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 5,
"power_usage_units": "Amps",
"power_usage_value": 5,
"power_usage_unit": "amps",
"power_usage_label": "5 Amps",
"created_at": "2026-06-03 08:50:21",
"updated_at": "2026-06-03 08:50:21"
}
],
"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.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/power-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/power-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/power-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": 433,
"name": "omnis",
"description": "Ea voluptas rerum vel quas.",
"item": {
"id": 983,
"name": null,
"label": "consequatur",
"type_id": 1842,
"location_id": 2786,
"status": "available",
"description": "Qui culpa iusto vero quod consequatur repellendus quis.",
"is_part": false,
"mountable": true,
"manufacturer": "Botsford-Kertzmann",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN869BR",
"serialnumber2": null,
"service_tag": "ST028OW",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:50:23.000000Z",
"updated_at": "2026-06-03T06:50:23.000000Z"
},
"colocation": null,
"port_number": 39,
"port_label": "eum",
"user_label": "animi",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 66,
"power_usage_units": "Amps",
"power_usage_value": 66,
"power_usage_unit": "amps",
"power_usage_label": "66 Amps",
"created_at": "2026-06-03 08:50:23",
"updated_at": "2026-06-03 08:50:23"
}
}
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": 434,
"name": "error",
"description": "Enim quia nostrum molestiae saepe cum.",
"item": null,
"colocation": null,
"port_number": 43,
"port_label": "numquam",
"user_label": "quod",
"outlet_state": "outletOff",
"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",
"created_at": "2026-06-03 08:50:24",
"updated_at": "2026-06-03 08:50:24"
}
}
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": 435,
"name": "quia",
"description": "Ut consequatur voluptatem commodi beatae magnam.",
"item": {
"id": 985,
"name": null,
"label": "at",
"type_id": 1846,
"location_id": 2794,
"status": "available",
"description": "Aliquam tempora recusandae dolor.",
"is_part": false,
"mountable": true,
"manufacturer": "Smitham-Williamson",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN062YJ",
"serialnumber2": null,
"service_tag": "ST714CA",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:50:26.000000Z",
"updated_at": "2026-06-03T06:50:26.000000Z"
},
"colocation": null,
"port_number": 39,
"port_label": "quia",
"user_label": "ipsam",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 65,
"power_usage_units": "Amps",
"power_usage_value": 65,
"power_usage_unit": "amps",
"power_usage_label": "65 Amps",
"created_at": "2026-06-03 08:50:26",
"updated_at": "2026-06-03 08:50: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.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": 436,
"name": "voluptas",
"description": "Voluptatem perspiciatis est nobis quos sed.",
"item": null,
"colocation": null,
"port_number": 33,
"port_label": "repellat",
"user_label": "voluptas",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 51,
"power_usage_units": "Amps",
"power_usage_value": 51,
"power_usage_unit": "amps",
"power_usage_label": "51 Amps",
"created_at": "2026-06-03 08:50:28",
"updated_at": "2026-06-03 08:50: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.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": 437,
"name": "et",
"description": "Mollitia cum tempora corrupti modi laudantium.",
"item": {
"id": 987,
"name": null,
"label": "optio",
"type_id": 1850,
"location_id": 2802,
"status": "available",
"description": "Velit reprehenderit corporis maiores provident.",
"is_part": false,
"mountable": true,
"manufacturer": "Wuckert PLC",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN194ED",
"serialnumber2": null,
"service_tag": "ST498RE",
"comments": null,
"notes": null,
"purchase_date": "2025-06-03",
"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-06-03T06:50:30.000000Z",
"updated_at": "2026-06-03T06:50:30.000000Z"
},
"colocation": null,
"port_number": 39,
"port_label": "architecto",
"user_label": "ea",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 29,
"power_usage_units": "Amps",
"power_usage_value": 29,
"power_usage_unit": "amps",
"power_usage_label": "29 Amps",
"created_at": "2026-06-03 08:50:30",
"updated_at": "2026-06-03 08:50: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.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": 438,
"name": "iure",
"description": "Sit culpa odio perspiciatis esse omnis.",
"item": null,
"colocation": null,
"port_number": 43,
"port_label": "sint",
"user_label": "quas",
"outlet_state": "up",
"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-06-03 08:50:31",
"updated_at": "2026-06-03 08:50:31"
}
}
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.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": 707,
"item_id": 989,
"name": "quibusdam",
"class": "Fans",
"type": "Power",
"unit": "Percent",
"index": "Power",
"reading": 730,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:50:34",
"updated_at": "2026-06-03 08:50:34"
},
{
"id": 708,
"item_id": 990,
"name": "vel",
"class": "Fans",
"type": "Power",
"unit": "RPM",
"index": "Power",
"reading": 506,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:50:34",
"updated_at": "2026-06-03 08:50:34"
}
],
"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": 709,
"item_id": 991,
"name": "nostrum",
"class": "Fans",
"type": "Thermal",
"unit": "Voltages",
"index": "Thermal",
"reading": 150,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:50:35",
"updated_at": "2026-06-03 08:50: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 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": 55,
"name": "illum",
"type": "Server",
"default": 0,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"position\";i:1;s:11:\"description\";i:2;s:5:\"label\";i:3;s:8:\"location\";i:4;s:5:\"model\";}s:18:\"traffic_statistics\";a:5:{i:0;s:23:\"widget_last_month_graph\";i:1;s:9:\"filtering\";i:2;s:17:\"left_sidebar_link\";i:3;s:20:\"widget_network_ports\";i:4;s:17:\"widget_last_month\";}s:5:\"power\";a:6:{i:0;s:20:\"widget_average_usage\";i:1;s:7:\"outlets\";i:2;s:9:\"filtering\";i:3;s:17:\"widget_last_month\";i:4;s:23:\"widget_last_month_graph\";i:5;s:17:\"left_sidebar_link\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"delete_rdns\";i:1;s:11:\"create_rdns\";i:2;s:11:\"update_rdns\";i:3;s:22:\"rdns_left_sidebar_link\";}}"
},
{
"id": 56,
"name": "exercitationem",
"type": "Colocation",
"default": 1,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:5:\"model\";i:1;s:11:\"description\";i:2;s:8:\"location\";i:3;s:8:\"position\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:9:\"filtering\";i:1;s:20:\"widget_network_ports\";i:2;s:23:\"widget_last_month_graph\";i:3;s:17:\"widget_last_month\";i:4;s:17:\"left_sidebar_link\";}s:5:\"power\";a:6:{i:0;s:23:\"widget_last_month_graph\";i:1;s:17:\"left_sidebar_link\";i:2;s:7:\"outlets\";i:3;s:9:\"filtering\";i:4;s:17:\"widget_last_month\";i:5;s:20:\"widget_average_usage\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"delete_rdns\";i:1;s:22:\"rdns_left_sidebar_link\";i:2;s:11:\"create_rdns\";i:3;s:11:\"update_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": 992,
"label": "dolorem",
"model": "veritatis",
"product_id": 0,
"model_id": 1451,
"parent_id": 0,
"type_id": 1860,
"user_id": 5080,
"order_id": 534,
"location_id": 2816,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Lowe-Okuneva",
"description": "Occaecati perferendis odio ea sunt.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN584UN",
"serialnumber2": null,
"service_tag": "ST675TL",
"location": "Hayes-Herzog",
"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": 993,
"label": "error",
"model": "temporibus",
"product_id": 0,
"model_id": 1453,
"parent_id": 0,
"type_id": 1862,
"user_id": 5087,
"order_id": 535,
"location_id": 2820,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Stanton-Rosenbaum",
"description": "Itaque et facere repudiandae.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN175RR",
"serialnumber2": null,
"service_tag": "ST070UX",
"location": "Will, Farrell and Heller",
"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": 994,
"product_id": 0,
"model_id": 1455,
"parent_id": 0,
"type_id": 1864,
"user_id": 5094,
"order_id": 536,
"location_id": 2824,
"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": "Simonis, Streich and Oberbrunner",
"serialnumber1": "SN866EL",
"serialnumber2": null,
"service_tag": "ST379MW",
"comments": null,
"label": "voluptatem",
"description": "Earum consequatur similique qui ex in soluta aut.",
"ip_addresses": [],
"purchase_date": "2025-06-03",
"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": 1864,
"name": "et",
"description": "Consequatur temporibus officia explicabo ut.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "lime",
"created_at": "2026-06-03 08:50:38",
"updated_at": "2026-06-03 08:50:38"
},
"model": {
"id": 1455,
"name": "omnis",
"label": null,
"type_id": 1864,
"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-06-03T06:50:40.000000Z",
"updated_at": "2026-06-03T06:50:40.000000Z"
},
"user": {
"id": 5094,
"username": "tyler76",
"email": "[email protected]",
"name": "Rebeca Christiansen",
"firstname": "Rebeca",
"lastname": "Christiansen",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/04dff3d024bf4538fb69aef67ad32d48?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/04dff3d024bf4538fb69aef67ad32d48?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": 2824,
"app_id": null,
"name": "Roberts LLC",
"address": "4795 Hegmann Track Apt. 009\nWest Dan, NM 45526-2311",
"city": "New Stacy",
"state": "Virginia",
"description": "Occaecati qui enim ad voluptatem vel sequi. Expedita voluptates dolorem debitis qui. Minima incidunt eaque delectus consequatur culpa.",
"notes": "Laudantium atque nesciunt dolores iusto et suscipit dolor. Architecto ut rerum et corrupti dolores. Velit ut et illo nobis incidunt nesciunt accusantium. Sit et eius aut dolor id.",
"emergency": "1",
"phone": "(864) 736-7091",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:39",
"updated_at": "2026-06-03 08:50:39"
},
"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": 995,
"product_id": 0,
"model_id": 1457,
"parent_id": 0,
"type_id": 1866,
"user_id": 5101,
"order_id": 537,
"location_id": 2828,
"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": "Franecki, Tillman and Stamm",
"serialnumber1": "SN285QW",
"serialnumber2": null,
"service_tag": "ST736GM",
"comments": null,
"label": "ut",
"description": "Quam dolor sapiente numquam architecto id.",
"ip_addresses": [],
"purchase_date": "2025-06-03",
"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": 1866,
"name": "voluptate",
"description": "Sint velit ab veniam quos fuga doloremque.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "black",
"created_at": "2026-06-03 08:50:40",
"updated_at": "2026-06-03 08:50:40"
},
"model": {
"id": 1457,
"name": "amet",
"label": null,
"type_id": 1866,
"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-06-03T06:50:41.000000Z",
"updated_at": "2026-06-03T06:50:41.000000Z"
},
"user": {
"id": 5101,
"username": "wkub",
"email": "[email protected]",
"name": "Bryana Murazik",
"firstname": "Bryana",
"lastname": "Murazik",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/be2192d1e6e1980b88c60063fdd637aa?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/be2192d1e6e1980b88c60063fdd637aa?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": 2828,
"app_id": null,
"name": "Heathcote-Keebler",
"address": "7820 Langosh Hill Suite 812\nMyronside, WA 08727",
"city": "Port Norvalshire",
"state": "New Hampshire",
"description": "Expedita ea non corrupti quisquam. Ut quod minima quia ducimus rerum eum perferendis. Maxime voluptates laboriosam illo laboriosam dolores debitis libero. Ad odio error odio deserunt minima ut quas.",
"notes": "Error cum dolor repudiandae est fugit distinctio ducimus. Qui tenetur inventore et nobis doloremque eveniet tempore ipsa. Aspernatur veritatis distinctio ea corrupti. Velit enim recusandae aut.",
"emergency": "0",
"phone": "(551) 279-2629",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:41",
"updated_at": "2026-06-03 08:50:41"
},
"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": 996,
"product_id": 0,
"model_id": 1459,
"parent_id": 0,
"type_id": 1868,
"user_id": 5108,
"order_id": 538,
"location_id": 2832,
"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": "Senger, O'Kon and Corwin",
"serialnumber1": "SN476CE",
"serialnumber2": null,
"service_tag": "ST739KP",
"comments": null,
"label": "molestias",
"description": "Sint natus qui est qui libero similique qui.",
"ip_addresses": [],
"purchase_date": "2025-06-03",
"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": 1868,
"name": "repellat",
"description": "Sunt blanditiis quisquam dolores adipisci facilis dignissimos nihil.",
"hardware": 0,
"software": 1,
"predefined": 1,
"color": "black",
"created_at": "2026-06-03 08:50:41",
"updated_at": "2026-06-03 08:50:41"
},
"model": {
"id": 1459,
"name": "placeat",
"label": null,
"type_id": 1868,
"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-06-03T06:50:43.000000Z",
"updated_at": "2026-06-03T06:50:43.000000Z"
},
"user": {
"id": 5108,
"username": "rnitzsche",
"email": "[email protected]",
"name": "Madisyn Quigley",
"firstname": "Madisyn",
"lastname": "Quigley",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/6e61862b3019d55608ee7f776f523b1e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/6e61862b3019d55608ee7f776f523b1e?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": 2832,
"app_id": null,
"name": "Pouros, Smith and Gerlach",
"address": "31137 Padberg Village Suite 489\nLake Jodieshire, NY 15052-2692",
"city": "North Ray",
"state": "Kentucky",
"description": "Temporibus veritatis repudiandae architecto cupiditate et. Quia deleniti enim voluptas facere. Repellendus aut dolorem est voluptas. Voluptatum voluptatem est consectetur dolorem qui.",
"notes": "Deserunt hic quo architecto dolorem voluptas asperiores. Deserunt ad rerum illum consequatur est. Dolorem porro enim voluptatem.",
"emergency": "0",
"phone": "+1-559-683-8263",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:42",
"updated_at": "2026-06-03 08:50:42"
},
"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": 997,
"product_id": 0,
"model_id": 1461,
"parent_id": 0,
"type_id": 1870,
"user_id": 5115,
"order_id": 539,
"location_id": 2836,
"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": "Williamson, Rippin and Ryan",
"serialnumber1": "SN402LU",
"serialnumber2": null,
"service_tag": "ST583XS",
"comments": null,
"label": "assumenda",
"description": "Culpa laborum vitae nihil laudantium optio libero ab nobis.",
"ip_addresses": [],
"purchase_date": "2025-06-03",
"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": 1870,
"name": "assumenda",
"description": "Quaerat libero qui a.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "lime",
"created_at": "2026-06-03 08:50:43",
"updated_at": "2026-06-03 08:50:43"
},
"model": {
"id": 1461,
"name": "minus",
"label": null,
"type_id": 1870,
"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-06-03T06:50:44.000000Z",
"updated_at": "2026-06-03T06:50:44.000000Z"
},
"user": {
"id": 5115,
"username": "bryan",
"email": "[email protected]",
"name": "Curt Hirthe",
"firstname": "Curt",
"lastname": "Hirthe",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/48c6b318b1cd6f514d2cd195d626f0e0?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/48c6b318b1cd6f514d2cd195d626f0e0?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": 2836,
"app_id": null,
"name": "Stracke, Bernier and Schroeder",
"address": "983 Rice Crossroad Apt. 248\nSouth Nyasiaport, MI 85690",
"city": "Starktown",
"state": "Pennsylvania",
"description": "Ipsum est non molestias earum sapiente ut assumenda. Eos dignissimos porro quidem nihil doloremque enim. Ratione vel ea accusantium quis enim dolor in.",
"notes": "Dolor quos nulla quia eveniet sequi facere quae. Aut autem aut esse maiores laudantium consequatur. Unde aut illo quia cumque ut. Est dolor enim ut harum culpa tempore praesentium.",
"emergency": "1",
"phone": "+1-628-213-6535",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:44"
},
"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\": [
3
],
\"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": [
3
],
"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' => [
3,
],
'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"
]
},
"legend": {
"header": [
"Current",
"Average",
"Maximum",
"95th %"
],
"rows": [
{
"label": "In",
"color": "#62C45E",
"values": [
632798.1868925721,
1372582.1214573288,
2053141.22367529,
2053141.22367529
]
},
{
"label": "Out",
"color": "#2BA7FF",
"values": [
639398.799042107,
1396441.8722763401,
1919831.1749942221,
1919831.1749942221
]
}
],
"format": "bits",
"footer": "Total 670.81 GB (In 332.34 GB Out 338.47 GB)"
},
"units": {
"traffic": "Mbps",
"power_usage": "Amps"
},
"precision": {
"traffic": "2"
}
}
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": 776,
"name": "qui adipisci est",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:44"
},
{
"id": 777,
"name": "repellendus aut mollitia",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:44"
}
],
"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": 778,
"name": "distinctio odit sed",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:44"
}
}
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": 779,
"name": "quos illum et",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:44"
}
}
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": 46,
"type": "ipv4",
"subnet": "235.231.74.46",
"mask": 24,
"gateway": "116.42.240.98"
},
{
"id": 47,
"type": "ipv4",
"subnet": "252.167.68.60",
"mask": 24,
"gateway": "51.195.93.85"
}
],
"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/in/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/in/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/in/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": 48,
"type": "ipv4",
"subnet": "156.230.234.100",
"mask": 24,
"gateway": "219.167.154.46"
}
}
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/qui/subnets/quos" \
--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/qui/subnets/quos'
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/qui/subnets/quos';
$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": 49,
"type": "ipv4",
"subnet": "242.134.123.34",
"mask": 24,
"gateway": "195.67.58.111"
}
}
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/debitis/subnets/aut" \
--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/debitis/subnets/aut'
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/debitis/subnets/aut';
$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": 86,
"name": "velit-iso",
"iso_url": "http://weber.com/corrupti-qui-et-rerum",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50:46"
},
{
"id": 87,
"name": "voluptas-iso",
"iso_url": "http://crona.com/cupiditate-dolorum-ratione-necessitatibus-minima-voluptas-magni",
"status": 2,
"status_label": "Started",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50:46"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 88,
"name": "est-iso",
"iso_url": "http://www.mills.com/",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50:46"
}
}
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": 89,
"name": "magni-iso",
"iso_url": "http://www.murazik.com/quibusdam-voluptas-optio-officia-est-inventore-quisquam",
"status": 4,
"status_label": "Error",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50: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.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": 90,
"name": "officia-iso",
"iso_url": "https://mcglynn.org/provident-quis-adipisci-ut-quia-dolorum-alias.html",
"status": 4,
"status_label": "Error",
"created_at": "2026-06-03 08:50:47",
"updated_at": "2026-06-03 08:50: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.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
Updated in 1.25.1
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": 200,
"template_id": 200,
"name": "quo",
"server_id": 449,
"tags": [
"ipsam",
"aut",
"consequuntur",
"consequatur",
"cum"
],
"architecture": "x64",
"cache_folder": "aspernatur",
"mirror": "http://www.hackett.net/officia-accusamus-aliquam-voluptates-est-fugit.html",
"edition": "aut",
"iso_url": "http://www.gislason.com/",
"tftp_url": "http://pfannerstill.org/",
"license": "tempore",
"gpxe": "Molestias molestias distinctio autem sit in quae error quas.",
"disk_layout": "Suscipit corporis suscipit facilis dolor aut.",
"packages": "Deleniti eum ipsum animi quis et.",
"post_installation": "Soluta ullam praesentium dolorem voluptate.",
"first_boot": "Libero aut sed aut ut accusantium aperiam architecto.",
"extras": "Voluptatem quia necessitatibus quia enim non iusto laboriosam.",
"timezone": "Europe/Bucharest",
"language": "cr",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 449,
"app_id": 814,
"name": "Keara Konopelski",
"module": "Remote Module",
"configuration": {
"app": 814,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "115.42.230.64",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
},
{
"id": 450,
"app_id": 815,
"name": "Bettie Hettinger",
"module": "Remote Module",
"configuration": {
"app": 815,
"rebootmethod": "manual",
"nameserver_1": "3.169.234.103",
"nameserver_2": "106.162.183.73",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
}
],
"provisioning_profiles": []
},
{
"id": 201,
"template_id": 201,
"name": "vero",
"server_id": 451,
"tags": [
"et",
"sit",
"saepe",
"dolorem",
"qui",
"voluptatem"
],
"architecture": "x64",
"cache_folder": "odio",
"mirror": "http://www.mills.com/magni-nam-eum-praesentium-deleniti-atque",
"edition": "aut",
"iso_url": "http://www.mertz.info/occaecati-voluptatum-non-earum",
"tftp_url": "https://berge.org/minus-esse-et-repudiandae-iste-nisi-qui-id.html",
"license": "tempora",
"gpxe": "Vel sed hic aut ut delectus quis.",
"disk_layout": "Velit eaque sed qui neque aperiam numquam.",
"packages": "Quia aut officiis maiores at esse vel quas.",
"post_installation": "Error omnis dolores magni.",
"first_boot": "Culpa maiores possimus nihil odio nobis.",
"extras": "Culpa ad ut sit labore dolores.",
"timezone": "Asia/Amman",
"language": "qu",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 451,
"app_id": 816,
"name": "Mateo Schinner PhD",
"module": "Remote Module",
"configuration": {
"app": 816,
"rebootmethod": "pdu",
"nameserver_1": "153.237.71.223",
"nameserver_2": "60.247.193.183",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "undionly.kpxe"
},
"enabled": 0
},
{
"id": 452,
"app_id": 817,
"name": "Kailey Bailey",
"module": "Remote Module",
"configuration": {
"app": 817,
"rebootmethod": "pdu",
"nameserver_1": null,
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 1
}
],
"provisioning_profiles": []
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/os/templates?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/os/templates",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
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
Updated in 1.25.1
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": 202,
"template_id": 202,
"name": "a",
"server_id": 453,
"tags": [
"natus",
"temporibus",
"aut",
"ipsa"
],
"architecture": "arm",
"cache_folder": "suscipit",
"mirror": "http://farrell.net/accusamus-et-ratione-soluta",
"edition": "possimus",
"iso_url": "https://www.schroeder.com/quibusdam-id-cupiditate-voluptate-voluptatum-dolorum-temporibus-omnis",
"tftp_url": "http://stroman.biz/",
"license": "ut",
"gpxe": "Quod dolorem reprehenderit facilis eveniet.",
"disk_layout": "Sint animi eligendi quia corrupti ab magnam harum.",
"packages": "Earum officia dolorem doloribus ipsam rerum vel.",
"post_installation": "Commodi aperiam doloremque tempora suscipit et ut.",
"first_boot": "Consequatur omnis aliquam aut blanditiis.",
"extras": "Ipsam perferendis commodi qui beatae.",
"timezone": "Asia/Atyrau",
"language": "sq",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 453,
"app_id": 818,
"name": "Carmelo Armstrong",
"module": "Remote Module",
"configuration": {
"app": 818,
"rebootmethod": "ipmi_easy",
"nameserver_1": "147.133.106.16",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
},
{
"id": 454,
"app_id": 819,
"name": "Verla Adams",
"module": "Remote Module",
"configuration": {
"app": 819,
"rebootmethod": "manual",
"nameserver_1": "195.177.98.220",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
}
],
"provisioning_profiles": []
}
}
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
Updated in 1.25.1
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": 203,
"template_id": 203,
"name": "ut",
"server_id": 455,
"tags": [
"cupiditate",
"non",
"dolore",
"quia",
"voluptate"
],
"architecture": "arm",
"cache_folder": "sed",
"mirror": "http://www.murazik.com/",
"edition": "tenetur",
"iso_url": "http://www.bahringer.info/ut-neque-dolor-officiis-et-itaque-voluptates-quisquam-aut.html",
"tftp_url": "http://effertz.com/laboriosam-qui-quia-hic-nulla-accusantium-beatae.html",
"license": "repellat",
"gpxe": "Blanditiis est ad soluta ipsam nobis autem.",
"disk_layout": "Qui ducimus unde dolor veritatis nemo incidunt mollitia.",
"packages": "Velit sapiente adipisci fuga dolorem qui voluptatem quasi.",
"post_installation": "Dolores facilis asperiores perspiciatis quis tempore.",
"first_boot": "Sint ut sint modi enim quaerat.",
"extras": "Quia totam voluptatem qui quia cupiditate facilis aliquid.",
"timezone": "Pacific/Kanton",
"language": "az",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 455,
"app_id": 820,
"name": "Tobin Schumm",
"module": "Remote Module",
"configuration": {
"app": 820,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "30.194.146.132",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"enabled": 0
},
{
"id": 456,
"app_id": 821,
"name": "Kadin Watsica",
"module": "Remote Module",
"configuration": {
"app": 821,
"rebootmethod": "pdu",
"nameserver_1": "196.171.141.131",
"nameserver_2": "9.221.103.136",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "vmware.kpxe"
},
"enabled": 1
}
],
"provisioning_profiles": []
}
}
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
Updated in 1.25.1
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": 204,
"template_id": 204,
"name": "quam",
"server_id": 457,
"tags": [
"dolore",
"rem",
"et",
"aut"
],
"architecture": "x86",
"cache_folder": "occaecati",
"mirror": "https://stiedemann.com/veniam-sed-ut-repudiandae-magni-nulla.html",
"edition": "sunt",
"iso_url": "https://www.torphy.org/et-voluptatem-dolorem-ab-aperiam-amet",
"tftp_url": "http://www.hermann.com/mollitia-necessitatibus-iure-dolor-omnis-repellat-excepturi-nostrum",
"license": "consequatur",
"gpxe": "Non doloremque sint consequuntur possimus.",
"disk_layout": "Quia earum autem voluptates neque officiis vel fugiat veritatis.",
"packages": "Itaque vel quibusdam modi temporibus id quia dicta.",
"post_installation": "Alias rerum necessitatibus architecto ipsum fuga.",
"first_boot": "Blanditiis ad soluta laudantium aliquid a rerum maxime.",
"extras": "Ut commodi recusandae soluta id ut itaque cumque.",
"timezone": "America/Martinique",
"language": "ka",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 457,
"app_id": 822,
"name": "Kailee McLaughlin DVM",
"module": "Remote Module",
"configuration": {
"app": 822,
"rebootmethod": "manual",
"nameserver_1": "6.42.168.72",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "undionly.kpxe"
},
"enabled": 0
},
{
"id": 458,
"app_id": 823,
"name": "Kelton Schinner",
"module": "Remote Module",
"configuration": {
"app": 823,
"rebootmethod": "ipmi_easy",
"nameserver_1": "34.225.248.24",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
}
],
"provisioning_profiles": []
}
}
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=6&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': '6',
'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' => '6',
'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": 81,
"server_id": 459,
"name": "America Rau",
"description": "Eos repudiandae minus et aperiam mollitia.",
"type": "firstboot",
"tag": "consequatur est",
"tags": [
"consequatur",
"est"
],
"data": "Suscipit illum modi ipsam est ut est maiores."
},
{
"id": 82,
"server_id": 460,
"name": "Mireya Hoppe",
"description": "Et ea nihil nihil maiores nihil quidem eaque.",
"type": "firstboot",
"tag": "explicabo amet",
"tags": [
"explicabo",
"amet"
],
"data": "Corrupti et sit ut laudantium quia dolor."
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/os/addons?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/os/addons",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
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": 83,
"server_id": 461,
"name": "Kenton Parker PhD",
"description": "Qui veniam aut nulla placeat culpa perspiciatis et.",
"type": "firstboot",
"tag": "pariatur assumenda",
"tags": [
"pariatur",
"assumenda"
],
"data": "Aut laborum neque reprehenderit ea ducimus."
}
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\": \"cumque\",
\"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": "cumque",
"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' => 'cumque',
'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": 84,
"server_id": 462,
"name": "Lillian Reilly V",
"description": "Omnis tempora aperiam itaque voluptatem velit.",
"type": "firstboot",
"tag": "dolor tempora",
"tags": [
"dolor",
"tempora"
],
"data": "Voluptas et veniam id dolor."
}
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\": \"at\",
\"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": "at",
"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' => 'at',
'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": 85,
"server_id": 463,
"name": "Desiree Paucek",
"description": "Eos temporibus autem omnis est non voluptates nobis.",
"type": "firstboot",
"tag": "est suscipit",
"tags": [
"est",
"suscipit"
],
"data": "Reiciendis vel ut nihil nulla."
}
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\": [
20
],
\"ssh_keys\": [
13
]
}"
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": [
20
],
"ssh_keys": [
13
]
}
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' => [
20,
],
'ssh_keys' => [
13,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 171,
"device_id": 1001,
"template_id": 205,
"server_id": 464,
"message": "Voluptas et nobis ex sequi quis.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-06-03 08:50:47",
"updated_at": "2026-06-03 08:50: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.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": 172,
"device_id": 1002,
"template_id": 206,
"server_id": 467,
"message": "Quisquam ut deleniti doloremque.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-06-03 08:50:47",
"updated_at": "2026-06-03 08:50: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.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": 173,
"device_id": 1003,
"template_id": 207,
"server_id": 470,
"message": "Omnis distinctio vel sit cupiditate aut qui.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-06-03 08:50:48",
"updated_at": "2026-06-03 08:50:48"
}
}
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
Updated in 1.25.1
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
Updated in 1.25.1
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\",
\"installation_lock\": \"1\"
}"
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",
"installation_lock": "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/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',
'installation_lock' => '1',
],
]
);
$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": 473,
"app_id": 838,
"name": "Myrna Mills",
"module": "Remote Module",
"configuration": {
"app": 838,
"rebootmethod": "ipmi_easy_uefi",
"nameserver_1": "194.104.225.34",
"nameserver_2": "70.159.88.106",
"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.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": 174,
"device_id": 1004,
"template_id": 208,
"server_id": 474,
"message": "Eos nobis et quas est et.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-06-03 08:50:48",
"updated_at": "2026-06-03 08:50:48"
},
{
"id": 175,
"device_id": 1005,
"template_id": 209,
"server_id": 477,
"message": "Optio debitis perferendis et aut harum.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-06-03 08:50:48",
"updated_at": "2026-06-03 08:50:48"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 112,
"device_id": 1006,
"server_id": 480,
"template": "Ward Torp",
"status": "",
"log": "",
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
},
{
"id": 113,
"device_id": 1007,
"server_id": 481,
"template": "Garrick Cartwright",
"status": "",
"log": "",
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
}
],
"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": 74,
"uuid": "d3eab61b-97fe-3717-ba70-d5a23a8233fe",
"name": "Firstboot nostrum",
"description": "Sequi sed neque voluptatibus laudantium.",
"type": {
"value": "firstboot",
"label": "FirstBoot (Bootstrap script)"
},
"version": "1.0",
"predefined": false,
"official": false,
"installation_template": "firstboot_ex",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
},
{
"id": 75,
"uuid": "fc2e0fa3-efc1-3634-bf07-65e6a6640221",
"name": "Preseed veniam",
"description": "Amet adipisci eius quia dolorem error et.",
"type": {
"value": "preseed",
"label": "Preseed (Debian/Ubuntu legacy)"
},
"version": "1.0",
"predefined": false,
"official": false,
"installation_template": "preseed_voluptas",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
}
],
"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": 76,
"uuid": "f7f189c0-286e-3039-a3ce-000f08d51758",
"name": "Startnet quam",
"description": "Maiores quis magnam et amet adipisci.",
"type": {
"value": "startnet",
"label": "Startnet (Windows)"
},
"version": "1.0",
"predefined": false,
"official": false,
"installation_template": "startnet_molestias",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50: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.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": 77,
"uuid": "5fe58126-a0d3-391e-8803-4f6c9113777c",
"name": "Autoinstall qui",
"description": "Et delectus voluptate temporibus eum nemo id neque.",
"type": {
"value": "autoinstall",
"label": "Autoinstall (Ubuntu cloud-init)"
},
"version": "1.1",
"predefined": false,
"official": false,
"installation_template": "autoinstall_consequatur",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50: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.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": 93,
"app_id": 848,
"name": "Fritz Larkin",
"locations": [
{
"id": 2885,
"app_id": null,
"name": "Pfeffer Inc",
"address": "84076 Samson Pine Suite 981\nWest Elyse, NJ 31052",
"city": "Hollieton",
"state": "Kentucky",
"description": "Soluta dolores consectetur expedita quae. Aut quae vel exercitationem ut placeat delectus. Autem minima voluptates nesciunt. Eum vitae omnis sit doloremque est non.",
"notes": "Qui sit tempora et dolorem enim incidunt. Veniam dolorum sint laudantium quod vel animi.",
"emergency": "1",
"phone": "(820) 431-0870",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
},
{
"id": 2886,
"app_id": null,
"name": "Sipes Ltd",
"address": "661 Erdman Radial\nHowellview, ND 39012-8516",
"city": "East Alisaville",
"state": "Tennessee",
"description": "Explicabo velit perspiciatis iusto magnam harum. Quas consequatur aliquid beatae ex. Voluptatibus eos sequi eius consequatur molestiae similique tempora molestiae. Magni officiis qui delectus et et amet.",
"notes": "Ipsa blanditiis consequatur incidunt nisi sint ducimus. Quod quibusdam et est nobis et. Odio rem quod quod aliquam dicta aut ea. Eos enim perferendis non eos rerum.",
"emergency": "0",
"phone": "620-920-7885",
"flag": "Germany.png",
"created_at": "2026-06-03 08:50:49",
"updated_at": "2026-06-03 08:50:49"
}
],
"configuration": []
},
{
"id": 94,
"app_id": 849,
"name": "Reva Mills",
"locations": [
{
"id": 2887,
"app_id": null,
"name": "Reinger-Barton",
"address": "1884 Krista Inlet\nWest Anabelview, ID 84178",
"city": "New Russport",
"state": "Alabama",
"description": "Vitae et libero natus voluptatem. Vel sequi molestias nihil dignissimos qui repellendus reiciendis. Voluptatem qui sed ipsum nemo. Perferendis maxime praesentium libero non.",
"notes": "Quod ut hic ex corporis. Illo aspernatur enim suscipit. Quae distinctio nostrum molestiae voluptas vel. Iusto consequatur beatae facilis commodi dicta adipisci suscipit.",
"emergency": "1",
"phone": "(786) 330-6094",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
},
{
"id": 2888,
"app_id": null,
"name": "Glover-Turner",
"address": "2186 Shaniya Bypass Apt. 736\nMcCluremouth, SD 87857-2782",
"city": "East Verlaland",
"state": "Indiana",
"description": "Impedit architecto deserunt laudantium. Nihil quidem rerum quae minima voluptatum numquam minima. Ea vero voluptatum voluptas non est.",
"notes": "Odio corrupti architecto tenetur et nemo. Autem voluptatem eius asperiores ullam sapiente necessitatibus animi. Est veniam culpa eos. Voluptas recusandae velit cupiditate perferendis dolores et.",
"emergency": "0",
"phone": "(513) 336-5805",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
}
],
"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": 95,
"app_id": 850,
"name": "Hollie Parker IV",
"locations": [
{
"id": 2889,
"app_id": null,
"name": "Blick-Skiles",
"address": "9935 Keshawn Glen Apt. 198\nAnkundingberg, IL 94736-5252",
"city": "Karinefurt",
"state": "Mississippi",
"description": "Reprehenderit corporis et repudiandae adipisci dolorem ipsa porro. Aut accusantium dolorum dicta ratione debitis fugiat natus atque. Sunt vero minima optio tempora sint iste dolorem. Aut eos temporibus officia nesciunt accusamus in. Distinctio et nesciunt possimus nesciunt.",
"notes": "Pariatur est est fugiat officiis quia. Quod maiores fuga voluptas dolores. Illo magnam reprehenderit est quam hic. Adipisci et tempora laudantium esse assumenda officia nam.",
"emergency": "0",
"phone": "(564) 466-2128",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
},
{
"id": 2890,
"app_id": null,
"name": "Marquardt Group",
"address": "96661 Winston Lakes Suite 849\nKubhaven, LA 50239",
"city": "South Lessieton",
"state": "Michigan",
"description": "Odio quia eum laborum fugit. Sint eius aliquam labore rerum nam. Voluptates sit est tempora excepturi dolorum est.",
"notes": "Soluta quo accusantium et repellendus. Voluptas neque occaecati explicabo. Veniam recusandae enim excepturi dolorum et.",
"emergency": "1",
"phone": "520-739-5116",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
}
],
"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\": [
13
],
\"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": [
13
],
"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' => [
13,
],
'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": 96,
"app_id": 851,
"name": "Emilia Cronin PhD",
"locations": [
{
"id": 2891,
"app_id": null,
"name": "Kuphal-Schneider",
"address": "571 Cydney Walk\nBartonmouth, CA 56291-6514",
"city": "Braulioton",
"state": "Wyoming",
"description": "Laborum quis enim nam ea mollitia cupiditate. Eveniet harum inventore nihil autem. Voluptate est quisquam repudiandae molestiae.",
"notes": "Deserunt pariatur velit ut rem. Qui et odio aspernatur et error. Eum consectetur quis et ut.",
"emergency": "0",
"phone": "+1.352.222.2849",
"flag": "Germany.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
},
{
"id": 2892,
"app_id": null,
"name": "Watsica and Sons",
"address": "2933 Stefan Rapids\nRunolfssonchester, NE 44685",
"city": "Lake Tyrel",
"state": "Alabama",
"description": "Error tenetur magni deleniti asperiores porro. Quia enim fuga occaecati minima quia voluptates asperiores. Vitae enim magni consectetur vel laudantium ut quia. Blanditiis iure qui voluptatem non tempora.",
"notes": "Et esse tenetur dolorum. Magnam velit earum aut voluptatem.",
"emergency": "0",
"phone": "(765) 538-8548",
"flag": "Canada.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
}
],
"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\": [
2
],
\"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": [
2
],
"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' => [
2,
],
'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": 97,
"app_id": 852,
"name": "Glenna Ortiz Sr.",
"locations": [
{
"id": 2893,
"app_id": null,
"name": "Kozey, Rowe and Bogisich",
"address": "64265 Schultz Port\nNew Kelley, NM 83070",
"city": "Port Blancaside",
"state": "Indiana",
"description": "Eos inventore quidem aut id consequatur. Sit molestiae eum rerum qui maxime voluptatem. Voluptas expedita error corporis. Ipsam architecto rerum laboriosam.",
"notes": "Quam quis fuga maxime sequi quod temporibus. Praesentium ea possimus sed qui quaerat. Fugiat eligendi aut ad quo aut.",
"emergency": "1",
"phone": "1-567-946-0119",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
},
{
"id": 2894,
"app_id": null,
"name": "Schowalter, Leffler and Abbott",
"address": "179 Schmitt Plaza\nNew Una, ME 40324",
"city": "Domenicton",
"state": "Ohio",
"description": "Quo veniam commodi nostrum consequatur. Illo dolores est nisi in itaque. Quia voluptates qui non aliquam quaerat nihil veniam. Explicabo sit autem ipsum et et quas explicabo.",
"notes": "Error incidunt sapiente voluptatem dolores libero. Dolor quia nisi et non sit consequuntur. Voluptatem reiciendis perspiciatis eos. Voluptatum vel autem est.",
"emergency": "0",
"phone": "+14406391627",
"flag": "UK.png",
"created_at": "2026-06-03 08:50:50",
"updated_at": "2026-06-03 08:50:50"
}
],
"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": 75,
"device_id": 1009,
"ipmi_proxy_id": 98,
"url": "https://192.168.203.150/client/console/36021/xmb8FmtS/2d92e00c93aa05e27c0f29fa78881360b79c660a",
"status": 1,
"message": "Est suscipit modi minus corrupti earum doloribus accusantium rerum.",
"log": null
},
{
"id": 76,
"device_id": 1010,
"ipmi_proxy_id": 99,
"url": "https://192.168.203.150/client/console/17132/VvBUvaCY/565dda42ba475c9bdfb8a7b180f9f4faf879d73c",
"status": 1,
"message": "Cum dolorem quia et laudantium dignissimos tempore.",
"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": 77,
"device_id": 1011,
"ipmi_proxy_id": 100,
"url": "https://192.168.203.150/client/console/58971/PcUzHbvv/ad5e15215ab69a966efad5a7531537b4c1761b41",
"status": 1,
"message": "Tenetur soluta omnis labore dolorem dolor.",
"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": 78,
"device_id": 1012,
"ipmi_proxy_id": 101,
"url": "https://192.168.203.150/client/console/17703/kFYP6fBs/8231204caf2d17f96814d4ed39762c688a56c12a",
"status": 1,
"message": "Qui qui beatae quidem velit.",
"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.IPMI Force Boot
requires authentication
Added in 1.25.1
Sets the boot flag that the device BMC should provide to the system firmware on boot.
Accepted values: force_pxe, force_disk, force_safe, force_diag, force_cdrom, force_bios.
Example request:
curl --request POST \
"https://your-easydcim.com/api/v3/admin/ipmi/1/force-boot" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"force_pxe\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/ipmi/1/force-boot'
payload = {
"type": "force_pxe"
}
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/1/force-boot';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'force_pxe',
],
]
);
$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 Boot Status
requires authentication
Added in 1.25.1
Returns current chassis boot flags reported by the BMC.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/ipmi/1/boot-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/boot-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/ipmi/1/boot-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"
}
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": 114,
"pool": "182.41.100.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Cum quis ut minus aut facilis quas molestias.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:51",
"updated_at": "2026-06-03 08:50:51"
},
{
"id": 115,
"pool": "227.157.244.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Perspiciatis reprehenderit cupiditate deleniti et aut corporis.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:51",
"updated_at": "2026-06-03 08:50:51"
}
],
"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": 116,
"pool": "26.248.60.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Corporis illum vitae in in fugit voluptatem omnis.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "26.248.60.1",
"end": "26.248.60.254"
}
]
},
"addressing": {
"network_address": "26.248.60.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "26.248.60.255",
"first_available_ip": "26.248.60.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-06-03 08:50:51",
"updated_at": "2026-06-03 08:50:51"
}
}
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": 117,
"pool": "3.157.178.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Et non explicabo aut enim rerum id at.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "3.157.178.1",
"end": "3.157.178.254"
}
]
},
"addressing": {
"network_address": "3.157.178.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "3.157.178.255",
"first_available_ip": "3.157.178.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
}
}
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": 118,
"pool": "240.227.222.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Qui magni odio assumenda deserunt quisquam non velit.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "240.227.222.1",
"end": "240.227.222.254"
}
]
},
"addressing": {
"network_address": "240.227.222.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "240.227.222.255",
"first_available_ip": "240.227.222.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
}
}
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": 119,
"pool": "186.189.207.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Omnis inventore asperiores aperiam.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "186.189.207.1",
"end": "186.189.207.254"
}
]
},
"addressing": {
"network_address": "186.189.207.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "186.189.207.255",
"first_available_ip": "186.189.207.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
}
}
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": 120,
"pool": "6.178.157.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Aperiam perspiciatis provident velit dolorem magnam maiores voluptatem.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
},
{
"id": 121,
"pool": "78.215.246.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Repellat possimus qui natus quasi qui.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
}
],
"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": 122,
"pool": "237.88.242.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Quaerat dolorem officiis voluptatibus neque quaerat vitae.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
},
{
"id": 123,
"pool": "170.124.90.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Ad quia voluptatem culpa consequatur.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-06-03 08:50:52",
"updated_at": "2026-06-03 08:50:52"
}
],
"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": 1013,
"label": "quas",
"model": "non",
"product_id": 0,
"model_id": 1477,
"parent_id": 0,
"type_id": 1902,
"user_id": 5270,
"order_id": 555,
"location_id": 2920,
"rack_id": 598,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Beahan and Sons",
"description": "Omnis et sed id dolorem repellendus.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN418ZS",
"serialnumber2": null,
"service_tag": "ST187OT",
"location": "Cremin, Corwin and Dooley",
"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": 1014,
"label": "harum",
"model": "quia",
"product_id": 0,
"model_id": 1478,
"parent_id": 0,
"type_id": 1904,
"user_id": 5277,
"order_id": 556,
"location_id": 2924,
"rack_id": 599,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "O'Connell-O'Conner",
"description": "Aut aliquam et laudantium quia.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN084DC",
"serialnumber2": null,
"service_tag": "ST157OS",
"location": "Howe, Schiller and Johnston",
"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": 58,
"device_id": null,
"vlan_vlan": 2394,
"vlan_name": "maxime omnis",
"description": "Tenetur doloribus cum odit sit distinctio accusamus error culpa.",
"vlan_type": "provisioning",
"vlan_status": "active",
"device": null
},
{
"id": 59,
"device_id": null,
"vlan_vlan": 3268,
"vlan_name": "qui nesciunt",
"description": "Voluptates est modi natus explicabo impedit sed.",
"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": 60,
"device_id": null,
"vlan_vlan": 2882,
"vlan_name": "nihil quis",
"description": "Aut nostrum rerum veniam quam tenetur occaecati.",
"vlan_type": "standard",
"vlan_status": "active",
"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": 61,
"device_id": null,
"vlan_vlan": 2454,
"vlan_name": "rem deserunt",
"description": "Et ratione aut nesciunt laudantium commodi quia.",
"vlan_type": "provisioning",
"vlan_status": "depreciated",
"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": 62,
"device_id": null,
"vlan_vlan": 2228,
"vlan_name": "blanditiis consequuntur",
"description": "Eius consequuntur velit illo quisquam.",
"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": 57,
"device_id": 1017,
"user_id": 5306,
"server_id": 84,
"ip": "31.183.221.44",
"from": "kihn.com",
"name": "mueller.biz",
"ttl": "3600",
"created_at": "2026-06-03 08:50:54",
"updated_at": "2026-06-03 08:50:54"
},
{
"id": 58,
"device_id": 1018,
"user_id": 5314,
"server_id": 85,
"ip": "166.244.203.116",
"from": "bailey.com",
"name": "dietrich.biz",
"ttl": "3600",
"created_at": "2026-06-03 08:50:54",
"updated_at": "2026-06-03 08:50: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/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": 59,
"device_id": 1019,
"user_id": 5322,
"server_id": 86,
"ip": "149.135.231.248",
"from": "ebert.com",
"name": "will.org",
"ttl": "3600",
"created_at": "2026-06-03 08:50:54",
"updated_at": "2026-06-03 08:50:54"
}
}
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": 60,
"device_id": 1020,
"user_id": 5330,
"server_id": 87,
"ip": "249.209.157.35",
"from": "schiller.com",
"name": "hettinger.org",
"ttl": "3600",
"created_at": "2026-06-03 08:50:55",
"updated_at": "2026-06-03 08:50: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 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": 28,
"device_id": 1021,
"server_id": 88,
"ip": "220.109.147.96",
"name": "dickens.com",
"created_at": "2026-06-03 08:50:55",
"updated_at": "2026-06-03 08:50:55"
},
{
"id": 29,
"device_id": 1022,
"server_id": 89,
"ip": "140.1.126.110",
"name": "ohara.net",
"created_at": "2026-06-03 08:50:56",
"updated_at": "2026-06-03 08:50: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/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": 30,
"device_id": 1023,
"server_id": 90,
"ip": "97.32.143.168",
"name": "goodwin.com",
"created_at": "2026-06-03 08:50:56",
"updated_at": "2026-06-03 08:50:56"
}
}
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": 4826,
"username": "skiles.kaden",
"firstname": "Hillary",
"lastname": "McCullough",
"name": "Hillary McCullough",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/ba768fce0030275b627f914ea3c87a9e?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/ba768fce0030275b627f914ea3c87a9e?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": 4827,
"username": "lebsack.rigoberto",
"firstname": "Vernon",
"lastname": "Mayer",
"name": "Vernon Mayer",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/bb0bd82c1df758caf3c97f64a0161def?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/bb0bd82c1df758caf3c97f64a0161def?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": 47,
"name": "tempora iste",
"ssh_key": "ssh-rsa MDgxZTFhYzc1OTgxNzhlZDRkYzE3NjhhNzU0MmI1YTRlMmI4Nzg2MTNlMDkyMTUzNjI3YzQxYzJhYTA1ZGRlMg== user@host",
"default": false,
"fingerprint": "ac:cb:45:6f:49:34:ab:ee:28:29:6a:3c:3e:84:52:35",
"created_at": "2026-06-03 08:49:27"
},
{
"id": 48,
"name": "nihil aut",
"ssh_key": "ssh-rsa MGQ3NzlhZTQyMjEwYzRlNDgyMjNiYjdmMTY1NWM2ODhjODkxNzg0MjdjMDBjZTVjMTYxZjUwNDYxMzBmNDc2Zg== user@host",
"default": false,
"fingerprint": "bc:a8:ba:43:03:bd:6d:32:e9:33:bc:f6:21:92:b8:fc",
"created_at": "2026-06-03 08:49:27"
}
],
"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": 49,
"name": "temporibus inventore",
"ssh_key": "ssh-rsa NjBlYTY1MThmNmNiMzcwMTEzYTIzNTM0NTVhNTY3ZDQ1NTRjNWI2YWYxZjlmMjg5YmJiN2Y5ZTQ3N2Q0ZjU0ZA== user@host",
"default": false,
"fingerprint": "42:b6:ad:64:0b:b1:eb:4c:08:df:e6:49:ea:b5:2e:97",
"created_at": "2026-06-03 08:49:27"
}
}
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": 50,
"name": "ad necessitatibus",
"ssh_key": "ssh-rsa N2I2NjQ1MzNhYTA4MWJjMmY3NjAyYmQxY2Y5ODExNTA4OThjOWYxMjI3ZWJmYTJhZDY5YzdiMWExZjNlZjE5Ng== user@host",
"default": false,
"fingerprint": "97:56:0c:0d:cc:d1:a1:85:03:fc:ed:47:e2:83:fd:19",
"created_at": "2026-06-03 08:49:27"
}
}
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": 51,
"name": "perspiciatis modi",
"ssh_key": "ssh-rsa MTJhOTE4MTliNjk0ZTk3MTUyOWRlNGIxMjc5ZmE1MDViNDU5ZTA5OGU1OWJmMmZiMTIxNTUyOTdiMzE4OWZjZg== user@host",
"default": false,
"fingerprint": "9f:85:0f:60:6f:36:1b:9e:2c:aa:7b:21:68:ff:48:5b",
"created_at": "2026-06-03 08:49:27"
}
}
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/16" \
--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/16'
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/16';
$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": 32,
"related_id": 945,
"related": {
"label": "quam",
"model": "ullam",
"location": "Gislason-Swaniawski",
"location_flag": "Canada.png",
"metadata": []
},
"type": "Colocation",
"status": "terminated",
"created_at": "2026-06-03 08:49:29"
},
{
"id": 33,
"related_id": 946,
"related": {
"label": "vel",
"model": "harum",
"location": "Upton-Schuster",
"location_flag": "USA.png",
"metadata": []
},
"type": "Colocation",
"status": "activated",
"created_at": "2026-06-03 08:49: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/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": 34,
"related_id": 947,
"type": "Server",
"status": "",
"created_at": "2026-06-03 08:49:33",
"related": {
"label": "est",
"model": "doloremque",
"location": "Roberts, Nitzsche and Huels",
"location_flag": "Canada.png",
"rack": "Unknown",
"device_status": "running",
"os_installation": 0,
"uptime": {
"is_down": false,
"value": "Unknown"
},
"image": null,
"ip_addresses": [],
"metadata": [],
"metadataGroups": []
},
"access_level": {
"id": 54,
"name": "facere",
"type": "Server",
"default": false,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:11:\"description\";i:1;s:5:\"model\";i:2;s:8:\"location\";i:3;s:8:\"position\";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: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:9:\"filtering\";i:1;s:17:\"widget_last_month\";i:2;s:17:\"left_sidebar_link\";i:3;s:23:\"widget_last_month_graph\";i:4;s:20:\"widget_average_usage\";i:5;s:7:\"outlets\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"create_rdns\";i:1;s:11:\"update_rdns\";i:2;s:22:\"rdns_left_sidebar_link\";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": 948,
"label": "voluptas",
"type": "consequuntur"
},
{
"id": 949,
"label": "numquam",
"type": "voluptate"
}
],
"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": 428,
"port_number": 18,
"port_label": "rem",
"user_label": "est",
"outlet_state": "Outlet On",
"connected_item": null,
"connected_port": null,
"power_usage": 67,
"power_usage_units": "Amps",
"power_usage_value": 67,
"power_usage_unit": "amps",
"power_usage_label": "67 Amps"
},
{
"id": 429,
"port_number": 31,
"port_label": "aliquid",
"user_label": "officia",
"outlet_state": "Outlet On",
"connected_item": null,
"connected_port": null,
"power_usage": 52,
"power_usage_units": "Amps",
"power_usage_value": 52,
"power_usage_unit": "amps",
"power_usage_label": "52 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": 430,
"port_number": 6,
"port_label": "sed",
"user_label": "omnis",
"outlet_state": "Outlet Off",
"connected_item": null,
"connected_port": null,
"power_usage": 2,
"power_usage_units": "Amps",
"power_usage_value": 2,
"power_usage_unit": "amps",
"power_usage_label": "2 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": 3334,
"name": null,
"port_number": 21,
"port_label": "et",
"user_label": "dolores",
"description": "Tenetur libero inventore modi adipisci.",
"if_type": "ethernetCsmacd",
"adminstate": "down",
"opstate": "up",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "10 kbps"
},
{
"id": 3335,
"name": null,
"port_number": 37,
"port_label": "temporibus",
"user_label": "sit",
"description": "Vel animi est nulla sed eius animi omnis.",
"if_type": "mplsTunnel",
"adminstate": "down",
"opstate": "up",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "100 bps"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/client/services/{id}/ports?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/client/services/{id}/ports",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
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": 704,
"item_id": 955,
"name": "sed",
"class": "Fans",
"type": "Thermal",
"unit": "Watts",
"index": "Thermal",
"reading": 593,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:49:43",
"updated_at": "2026-06-03 08:49:43"
},
{
"id": 705,
"item_id": 956,
"name": "maxime",
"class": "Fans",
"type": "Power",
"unit": "Watts",
"index": "Power",
"reading": 935,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:49:44",
"updated_at": "2026-06-03 08:49:44"
}
],
"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": 706,
"item_id": 957,
"name": "qui",
"class": "Fans",
"type": "Power",
"unit": "Volts",
"index": "Power",
"reading": 638,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-06-03 08:49:45",
"updated_at": "2026-06-03 08:49: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.|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"
]
},
"legend": {
"header": [
"Current",
"Average",
"Maximum",
"95th %"
],
"rows": [
{
"label": "In",
"color": "#62C45E",
"values": [
632798.1868925721,
1372582.1214573288,
2053141.22367529,
2053141.22367529
]
},
{
"label": "Out",
"color": "#2BA7FF",
"values": [
639398.799042107,
1396441.8722763401,
1919831.1749942221,
1919831.1749942221
]
}
],
"format": "bits",
"footer": "Total 670.81 GB (In 332.34 GB Out 338.47 GB)"
},
"units": {
"traffic": "Mbps",
"power_usage": "Amps"
},
"precision": {
"traffic": "2"
}
}
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": 82,
"name": "cumque-iso",
"iso_url": "http://www.wiegand.com/et-enim-ipsum-perspiciatis-et-voluptatem-placeat",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-06-03 08:50:44",
"updated_at": "2026-06-03 08:50:45"
},
{
"id": 83,
"name": "voluptatem-iso",
"iso_url": "https://jacobs.com/voluptatem-sunt-vel-expedita-atque.html",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-06-03 08:50:45",
"updated_at": "2026-06-03 08:50:45"
}
],
"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": 84,
"name": "dolore-iso",
"iso_url": "http://www.ortiz.com/cupiditate-ex-fugit-debitis-illo",
"status": 3,
"download": {
"status": "finished",
"message": "The ISO image download has completed successfully."
},
"created_at": "2026-06-03 08:50:45",
"updated_at": "2026-06-03 08:50: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.|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": 85,
"name": "minus-iso",
"iso_url": "https://bradtke.com/culpa-blanditiis-consequatur-aut-atque-et.html",
"status": 4,
"download": {
"status": "error",
"message": "Download error: Unknown error occurred."
},
"created_at": "2026-06-03 08:50:45",
"updated_at": "2026-06-03 08:50: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.|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": 195,
"template_id": 195,
"name": "nihil",
"tags": [
"necessitatibus",
"beatae",
"ea"
],
"architecture": "arm",
"cache_folder": "rem",
"mirror": "http://ankunding.org/quibusdam-suscipit-facere-harum-aut.html",
"edition": "labore",
"iso_url": "https://www.grant.com/consequatur-vero-perferendis-qui-aliquid-nisi-tenetur-omnis",
"tftp_url": "http://www.fisher.org/",
"license": "aliquam",
"gpxe": "Eveniet aut qui ut qui est et.",
"disk_layout": "Odio blanditiis quas qui.",
"packages": "Qui ut quia amet suscipit ab error.",
"post_installation": "Quaerat magnam repellendus laborum vitae aspernatur sed.",
"first_boot": "Dolore earum ducimus soluta.",
"extras": "Tempore molestiae perferendis ut dolorem enim quod.",
"timezone": "Asia/Oral",
"language": "uz",
"family": "",
"is_windows": false,
"is_rescue": false
},
{
"id": 196,
"template_id": 196,
"name": "natus",
"tags": [
"maiores",
"sed",
"repudiandae",
"ab",
"illo"
],
"architecture": "arm",
"cache_folder": "veniam",
"mirror": "http://www.shields.com/facere-cupiditate-temporibus-voluptas-vel-consequatur-repellendus",
"edition": "qui",
"iso_url": "https://www.thiel.com/iusto-delectus-expedita-quo-praesentium-unde-mollitia-cum",
"tftp_url": "http://www.tromp.biz/sed-nihil-saepe-dolorem-in-quia.html",
"license": "omnis",
"gpxe": "Quia tempore dolores repellat quia non eligendi.",
"disk_layout": "Nam officia iure accusantium.",
"packages": "Dicta quisquam velit velit quia.",
"post_installation": "Quod vel ipsa necessitatibus sed sit ipsa.",
"first_boot": "Veritatis aliquid explicabo sequi quos cum.",
"extras": "Aliquam hic perferendis perferendis repudiandae vel.",
"timezone": "America/Argentina/Ushuaia",
"language": "no",
"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": 79,
"name": "Stephania Zemlak",
"description": "At qui ut optio reiciendis illum.",
"type": "postinstall",
"tag": "quas recusandae",
"tags": [
"quas",
"recusandae"
],
"data": "Quam non repellendus vero."
},
{
"id": 80,
"name": "Johathan West",
"description": "Incidunt sequi debitis nam quod quidem exercitationem tenetur.",
"type": "postinstall",
"tag": "ipsum rerum",
"tags": [
"ipsum",
"rerum"
],
"data": "Itaque sit repudiandae laborum et facere."
}
],
"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\": [
8
],
\"ssh_keys\": [
5
]
}"
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": [
8
],
"ssh_keys": [
5
]
}
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' => [
8,
],
'ssh_keys' => [
5,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 168,
"device_id": 998,
"template_id": 197,
"message": "Numquam aut facere dolor sapiente nam enim tempora praesentium.",
"log": "",
"created_at": "2026-06-03 08:50:45",
"updated_at": "2026-06-03 08:50: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.|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": 169,
"device_id": 999,
"template_id": 198,
"message": "Aut optio aperiam a commodi placeat earum.",
"log": "",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50:46"
}
}
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": 170,
"device_id": 1000,
"template_id": 199,
"message": "Earum saepe quos et iste quisquam enim.",
"log": "",
"created_at": "2026-06-03 08:50:46",
"updated_at": "2026-06-03 08:50:46"
}
}
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.Lock OS Installation
requires authentication
Added in 1.25.1
Locks the OS installation process for this device, preventing any OS reinstallation.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/services/123/os/lock" \
--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/lock'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/lock';
$response = $client->put(
$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.Unlock OS Installation
requires authentication
Added in 1.25.1
Unlocks the OS installation process for this device.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/client/services/123/os/unlock" \
--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/unlock'
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/unlock';
$response = $client->put(
$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.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": 74,
"device_id": 1008,
"url": "https://192.168.203.150/client/console/58115/zmp62wvZ/cebf2169f7124e9eb72c420f23f31738927fe753",
"status": 1,
"message": "Dignissimos labore distinctio eum."
}
}
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": 112,
"subnet": "59.135.154.0/24",
"pool": "59.135.154.0",
"mask": 24,
"gateway": null,
"type": "ipv4"
},
{
"id": 113,
"subnet": "88.94.240.0/24",
"pool": "88.94.240.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": 55,
"device_id": 1015,
"user_id": 5290,
"server_id": 82,
"ip": "55.48.177.20",
"from": "hand.com",
"name": "herzog.com",
"ttl": "3600",
"created_at": "2026-06-03 08:50:53",
"updated_at": "2026-06-03 08:50:53"
},
{
"id": 56,
"device_id": 1016,
"user_id": 5298,
"server_id": 83,
"ip": "201.1.31.173",
"from": "doyle.net",
"name": "little.org",
"ttl": "3600",
"created_at": "2026-06-03 08:50:53",
"updated_at": "2026-06-03 08:50:53"
}
],
"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.