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
},
"navigation": {
"iso_images": true,
"ssh_keys": 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\": false
},
\"my_account\": {
\"two_factor_auth\": true
},
\"navigation\": {
\"iso_images\": true,
\"ssh_keys\": false
}
}
}"
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": false
},
"my_account": {
"two_factor_auth": true
},
"navigation": {
"iso_images": true,
"ssh_keys": 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/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' => false,
],
'my_account' => [
'two_factor_auth' => true,
],
'navigation' => [
'iso_images' => true,
'ssh_keys' => false,
],
],
],
]
);
$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": 4189,
"app_id": null,
"name": "Swift PLC",
"address": "586 Maximillian Key\nWittingchester, RI 68536-8969",
"city": "Homenickside",
"state": "New Jersey",
"description": "Rerum incidunt dicta molestiae consequatur. Est molestias quae totam. Et mollitia optio dolor temporibus dolorem molestiae sint unde.",
"notes": "Dolores fugiat itaque dolorem amet. Facere ut sint nesciunt enim dolor animi quae saepe.",
"emergency": "1",
"phone": "1-386-485-4121",
"flag": "USA.png",
"created_at": "2026-08-14 14:24:42",
"updated_at": "2026-08-14 14:24:42"
},
{
"id": 4190,
"app_id": null,
"name": "Klocko-Roob",
"address": "3270 West Run Apt. 280\nNorth Jesse, NY 04994",
"city": "Rutherfordland",
"state": "Kansas",
"description": "Reiciendis magnam eum vel impedit. Esse optio tempore voluptatem minus quos. Porro et id recusandae aliquid id consequatur.",
"notes": "Voluptatibus magnam fuga quod est dignissimos aliquid odit. Eum optio illo ipsa est.",
"emergency": "1",
"phone": "+1 (469) 520-3940",
"flag": "USA.png",
"created_at": "2026-08-14 14:24:43",
"updated_at": "2026-08-14 14:24:43"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/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": 4191,
"app_id": null,
"name": "Barton-Hickle",
"address": "630 Johnston Alley Suite 727\nNorth Loganport, MD 33321-6044",
"city": "Rachelborough",
"state": "West Virginia",
"description": "Laudantium aut vel quia aliquam nemo rerum corporis. Ducimus quasi sit odit quis velit cum. Nulla sunt similique ad omnis dolorem illo laudantium. Et porro et sit laboriosam.",
"notes": "Fuga est aliquid illo libero qui temporibus. Et voluptatem suscipit explicabo nostrum. Et qui maxime aspernatur iusto qui mollitia deleniti. Ex et repellat dolorem aspernatur minima distinctio.",
"emergency": "1",
"phone": "1-442-841-1393",
"flag": "Germany.png",
"created_at": "2026-08-14 14:24:45",
"updated_at": "2026-08-14 14:24:45"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 4192,
"app_id": null,
"name": "Fay, Krajcik and Stark",
"address": "780 Skylar Walk Suite 184\nSatterfieldborough, MT 86580-7479",
"city": "Magdalenafort",
"state": "Florida",
"description": "Id error consequatur est rem nihil. A recusandae rerum corporis vitae labore ut.",
"notes": "Eos rerum sunt fuga ut et voluptatem animi. Voluptatem quia dignissimos ut consectetur. Enim quas incidunt atque nesciunt ad. Recusandae sapiente omnis facilis fuga deserunt.",
"emergency": "1",
"phone": "(989) 574-0745",
"flag": "USA.png",
"created_at": "2026-08-14 14:24:46",
"updated_at": "2026-08-14 14:24: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": 4193,
"app_id": null,
"name": "Stokes Inc",
"address": "80593 Senger Fords Apt. 268\nAufderharside, NY 53035",
"city": "South Marisahaven",
"state": "Kansas",
"description": "Aut ea accusantium quia qui officiis omnis. At voluptatibus a voluptatem vero tenetur aut excepturi. Perspiciatis quas nostrum aut tenetur deleniti est eum. Debitis libero quo est numquam.",
"notes": "Consequatur eaque dolor omnis magnam quam illo. Fugiat ipsa repudiandae molestias rem excepturi dolores sunt. Nam dolor culpa cupiditate quis accusantium.",
"emergency": "1",
"phone": "+1.831.218.1103",
"flag": "UK.png",
"created_at": "2026-08-14 14:24:47",
"updated_at": "2026-08-14 14:24: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": 821,
"name": "perspiciatis",
"floor_id": 811,
"location_id": 4194,
"description": "Enim ut molestiae natus ducimus eos est sit.",
"room": "non",
"units_number": 85,
"weight": 143,
"speed": 100,
"manager_id": 7626,
"location": {
"id": 4194,
"app_id": null,
"name": "Kozey LLC",
"address": "111 Lyric Walks Apt. 755\nGabrielleside, RI 95682-9622",
"city": "South Eliezerfort",
"state": "Colorado",
"description": "Vero possimus officia perferendis voluptas ut et. Voluptatem magnam rem voluptatibus iure. Sunt sit iure vitae dolores.",
"notes": "Voluptate quod asperiores eum deleniti magnam vitae quibusdam. Commodi modi explicabo autem nemo amet repudiandae quos. Non quas quis inventore.",
"emergency": "0",
"phone": "+1-920-570-9765",
"flag": "UK.png",
"created_at": "2026-08-14 14:24:49",
"updated_at": "2026-08-14 14:24:49"
},
"floor": {
"id": 811,
"name": "quaerat",
"number": 79,
"rows": 4,
"columns": 5,
"racks": [
{
"id": 821,
"name": "perspiciatis"
}
],
"created_at": "2026-08-14 14:24:50",
"updated_at": "2026-08-14 14:24:50"
},
"manager": {
"id": 7626,
"username": "javon.rodriguez",
"email": "[email protected]",
"name": "Conner Goldner",
"firstname": "Conner",
"lastname": "Goldner",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/d12038c8315e136360db85a599720463?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/d12038c8315e136360db85a599720463?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-08-14 14:24:50",
"updated_at": "2026-08-14 14:24:50"
},
{
"id": 822,
"name": "praesentium",
"floor_id": 812,
"location_id": 4196,
"description": "Enim placeat voluptas aut optio omnis ea.",
"room": "nobis",
"units_number": 91,
"weight": 53,
"speed": 10,
"manager_id": 7629,
"location": {
"id": 4196,
"app_id": null,
"name": "Armstrong Group",
"address": "454 Deion Fork Apt. 627\nArloport, KY 63733-5129",
"city": "New Erikaview",
"state": "Wisconsin",
"description": "Laboriosam saepe facere mollitia nihil consequatur. Consequatur rerum unde voluptate qui. Porro labore quibusdam optio sit aut deleniti non voluptatem. Minus cupiditate deleniti placeat non tenetur.",
"notes": "Qui tenetur veniam dolorem neque in. Pariatur mollitia iste quas cupiditate sed. Corrupti optio est velit sed.",
"emergency": "0",
"phone": "(909) 559-8308",
"flag": "USA.png",
"created_at": "2026-08-14 14:24:51",
"updated_at": "2026-08-14 14:24:51"
},
"floor": {
"id": 812,
"name": "itaque",
"number": 62,
"rows": 5,
"columns": 7,
"racks": [
{
"id": 822,
"name": "praesentium"
}
],
"created_at": "2026-08-14 14:24:53",
"updated_at": "2026-08-14 14:24:53"
},
"manager": {
"id": 7629,
"username": "tmayer",
"email": "[email protected]",
"name": "Addison Predovic",
"firstname": "Addison",
"lastname": "Predovic",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/aed290133855a646d0faab61a6de4b88?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/aed290133855a646d0faab61a6de4b88?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-08-14 14:24:53",
"updated_at": "2026-08-14 14:24: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/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": 823,
"name": "eveniet",
"floor_id": 813,
"location_id": 4198,
"description": "Deserunt velit qui omnis blanditiis.",
"room": "iste",
"units_number": 116,
"weight": 188,
"speed": 100,
"manager_id": 7632,
"location": {
"id": 4198,
"app_id": null,
"name": "Heidenreich, Harris and Leuschke",
"address": "434 Erick Shoal Apt. 813\nEast Erica, LA 19522",
"city": "Port Estefania",
"state": "Utah",
"description": "Sed qui autem culpa sunt. Et quo natus velit ad. Blanditiis ut praesentium qui laudantium consectetur facere quas.",
"notes": "Aut repellendus a sed itaque quo aperiam. Excepturi explicabo omnis tenetur commodi rem exercitationem voluptatem sit. Sunt voluptas voluptatem voluptatum qui sit.",
"emergency": "1",
"phone": "1-585-269-9262",
"flag": "Germany.png",
"created_at": "2026-08-14 14:24:54",
"updated_at": "2026-08-14 14:24:54"
},
"floor": {
"id": 813,
"name": "molestiae",
"number": 96,
"rows": 4,
"columns": 5,
"racks": [
{
"id": 823,
"name": "eveniet"
}
],
"created_at": "2026-08-14 14:24:55",
"updated_at": "2026-08-14 14:24:55"
},
"manager": {
"id": 7632,
"username": "marietta95",
"email": "[email protected]",
"name": "Korbin Donnelly",
"firstname": "Korbin",
"lastname": "Donnelly",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/5836306ded98bf2b73f04268194e49e5?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/5836306ded98bf2b73f04268194e49e5?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-08-14 14:24:55",
"updated_at": "2026-08-14 14:24: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.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": 824,
"name": "maiores",
"floor_id": 814,
"location_id": 4200,
"description": "Aspernatur fuga rerum et molestiae deserunt sed suscipit placeat.",
"room": "quibusdam",
"units_number": 16,
"weight": 154,
"speed": 1000,
"manager_id": 7635,
"location": {
"id": 4200,
"app_id": null,
"name": "Schmeler-McDermott",
"address": "81397 Zander Squares Suite 907\nFriedafort, NE 83736-7040",
"city": "Pamelaside",
"state": "Illinois",
"description": "Rerum sunt ratione consequatur perferendis et error. Labore architecto magni velit voluptatem vero. Id ut quo aliquid. Iusto ipsam enim et.",
"notes": "Repellat fugit minus eos eaque sint. Quia maiores inventore dolorem nihil eveniet corporis. Sit voluptatum est nesciunt amet qui et sed. Libero debitis maxime exercitationem et nemo veniam.",
"emergency": "1",
"phone": "785.968.7222",
"flag": "Canada.png",
"created_at": "2026-08-14 14:24:57",
"updated_at": "2026-08-14 14:24:57"
},
"floor": {
"id": 814,
"name": "maxime",
"number": 5,
"rows": 5,
"columns": 9,
"racks": [
{
"id": 824,
"name": "maiores"
}
],
"created_at": "2026-08-14 14:24:58",
"updated_at": "2026-08-14 14:24:58"
},
"manager": {
"id": 7635,
"username": "wilfrid.reynolds",
"email": "[email protected]",
"name": "Buck Emmerich",
"firstname": "Buck",
"lastname": "Emmerich",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/e1f989b534d6a59754253f9fa1fb42eb?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/e1f989b534d6a59754253f9fa1fb42eb?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-08-14 14:24:58",
"updated_at": "2026-08-14 14:24:58"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 825,
"name": "sed",
"floor_id": 815,
"location_id": 4202,
"description": "Ex numquam iusto enim cum.",
"room": "impedit",
"units_number": 6,
"weight": 172,
"speed": 1000,
"manager_id": 7638,
"location": {
"id": 4202,
"app_id": null,
"name": "Gibson, Kilback and Olson",
"address": "4785 Skiles Views\nNorth Lilliebury, MN 76220-0573",
"city": "Herzogland",
"state": "Indiana",
"description": "Ut fugiat quis alias deleniti omnis impedit ab. In totam ab voluptates unde rerum. Enim ut magnam asperiores facilis rerum consequuntur eum. Sit et dicta architecto dolorem omnis ratione.",
"notes": "Ipsum rerum quisquam quia velit accusantium earum nemo vero. Error beatae et tempora at soluta. Beatae eius quisquam delectus odio. Dignissimos veritatis rerum laborum aut.",
"emergency": "1",
"phone": "+1 (551) 782-1457",
"flag": "UK.png",
"created_at": "2026-08-14 14:24:59",
"updated_at": "2026-08-14 14:24:59"
},
"floor": {
"id": 815,
"name": "nesciunt",
"number": 9,
"rows": 2,
"columns": 4,
"racks": [
{
"id": 825,
"name": "sed"
}
],
"created_at": "2026-08-14 14:25:01",
"updated_at": "2026-08-14 14:25:01"
},
"manager": {
"id": 7638,
"username": "csmitham",
"email": "[email protected]",
"name": "Allene Schulist",
"firstname": "Allene",
"lastname": "Schulist",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/67ddcb94cf8a5bc5ef81940bb5023719?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/67ddcb94cf8a5bc5ef81940bb5023719?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-08-14 14:25:01",
"updated_at": "2026-08-14 14:25: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.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": 816,
"name": "aut",
"number": 3,
"rows": 9,
"columns": 7,
"racks": [],
"created_at": "2026-08-14 14:25:02",
"updated_at": "2026-08-14 14:25:02"
},
{
"id": 817,
"name": "nesciunt",
"number": 90,
"rows": 9,
"columns": 8,
"racks": [],
"created_at": "2026-08-14 14:25:04",
"updated_at": "2026-08-14 14:25: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/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": 818,
"name": "sit",
"number": 97,
"rows": 5,
"columns": 2,
"racks": [],
"created_at": "2026-08-14 14:25:05",
"updated_at": "2026-08-14 14:25:05"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 819,
"name": "saepe",
"number": 57,
"rows": 7,
"columns": 4,
"racks": [],
"created_at": "2026-08-14 14:25:06",
"updated_at": "2026-08-14 14:25:06"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update floor
requires authentication
Updates the specified floor with provided data.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/floors/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Updated Floor 2\",
\"number\": 3,
\"rows\": 12,
\"columns\": 15,
\"location_id\": 2
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/floors/3'
payload = {
"name": "Updated Floor 2",
"number": 3,
"rows": 12,
"columns": 15,
"location_id": 2
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/floors/3';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Updated Floor 2',
'number' => 3,
'rows' => 12,
'columns' => 15,
'location_id' => 2,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 820,
"name": "voluptatum",
"number": 5,
"rows": 5,
"columns": 1,
"racks": [],
"created_at": "2026-08-14 14:25:08",
"updated_at": "2026-08-14 14:25:08"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete 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": 2074,
"name": "fuga",
"label": "non",
"type_id": 2607,
"type": {
"id": 2607,
"name": "minima"
},
"location_id": 4209,
"status": "available",
"description": "Laudantium rerum voluptate ipsum ut.",
"is_part": true,
"mountable": false,
"manufacturer": "Wintheiser-Hudson",
"position": "aut",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/002244?text=iusto",
"data_ports": 6,
"serialnumber1": "8817b8d1-1ecb-3b1f-85aa-644b8254e11b",
"serialnumber2": "87a52e87-32de-3655-b3a5-b14b1ecb6f20",
"service_tag": "8c6a8fb7-cc20-3690-b48e-56cd79fa9996",
"comments": "Nemo ut aut facilis vel in nulla et. Totam quis cumque est est eveniet quasi. Pariatur magni eum eaque consectetur esse non fugit. Error quibusdam temporibus quae velit laborum eos assumenda animi.",
"notes": "Voluptatem ut consequatur adipisci facilis. Unde ut enim maxime ea.",
"purchase_date": "2015-02-15",
"warranty_months": 22,
"warranty_info": "Repellat similique enim labore nesciunt eaque.",
"function": "accusantium",
"maintenance_instruction": "Minima provident facilis qui sunt molestiae ullam autem. Aut et consequatur delectus ut dolores atque. Et distinctio ipsa aut dolorum illo quia at.",
"origin": "Djibouti",
"buy_price": 699.76,
"appdata": "a:1:{s:3:\"key\";s:6:\"maxime\";}",
"fields_data": "a:1:{s:5:\"field\";s:6:\"itaque\";}",
"parts_data": "a:1:{s:4:\"part\";s:2:\"ut\";}",
"created_at": "2026-08-14T12:25:09.000000Z",
"updated_at": "2026-08-14T12:25:09.000000Z"
},
{
"id": 2075,
"name": "exercitationem",
"label": "consectetur",
"type_id": 2608,
"type": {
"id": 2608,
"name": "labore"
},
"location_id": 4210,
"status": "unavailable",
"description": "Minus dolorem iste quibusdam et excepturi laboriosam sed.",
"is_part": false,
"mountable": true,
"manufacturer": "Bogan-Dare",
"position": "est",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/008855?text=maiores",
"data_ports": 9,
"serialnumber1": "e875f68a-b7ae-3b67-8793-96912659739d",
"serialnumber2": "b196a996-1502-3685-bcf4-ec165d3d19c0",
"service_tag": "90a78eb4-8f08-3c12-959d-13db7248a46f",
"comments": "Doloribus vero corrupti incidunt esse voluptates sed ut. Veniam nostrum voluptatibus deleniti voluptatum numquam. Tempore nulla dolor iste odio quasi aut.",
"notes": "Voluptas ad non libero ea fugiat nulla. Eum quidem ut molestias odio qui tempore. Aliquid eius sed placeat aut earum cupiditate et ex.",
"purchase_date": "1980-02-14",
"warranty_months": 28,
"warranty_info": "Magni labore quo est dolor ab libero.",
"function": "laudantium",
"maintenance_instruction": "Temporibus officia soluta quis aut distinctio aliquam neque autem. Et et rerum id est porro id. Expedita nam minima unde et ipsa sunt. Et quos rerum ut debitis laborum quo.",
"origin": "Niue",
"buy_price": 451,
"appdata": "a:1:{s:3:\"key\";s:2:\"ad\";}",
"fields_data": "a:1:{s:5:\"field\";s:11:\"consequatur\";}",
"parts_data": "a:1:{s:4:\"part\";s:5:\"dolor\";}",
"created_at": "2026-08-14T12:25:11.000000Z",
"updated_at": "2026-08-14T12:25:11.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": 2076,
"name": "perferendis",
"label": "dolor",
"type_id": 2609,
"type": {
"id": 2609,
"name": "animi"
},
"location_id": 4211,
"status": "available",
"description": "Similique sed quo iste ut nihil.",
"is_part": false,
"mountable": true,
"manufacturer": "Grimes-Tromp",
"position": "at",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/0099dd?text=deleniti",
"data_ports": 6,
"serialnumber1": "0121e868-f689-332f-a46e-8732c2ab7809",
"serialnumber2": "596fa82a-3107-3f8c-ab19-ef02b0b1b8e9",
"service_tag": "c4179f40-45ac-3aa1-85fb-f82a5156b49f",
"comments": "Consequatur ipsam consequatur fuga. Nihil quia minima corporis maiores. Similique dolor ea minus modi fuga explicabo eos.",
"notes": "Cupiditate debitis ipsum quidem dolorum enim voluptatem. Blanditiis maiores quasi rerum assumenda eos quam. A tempore et quibusdam.",
"purchase_date": "2013-09-11",
"warranty_months": 22,
"warranty_info": "Dolor magni magni nihil aut autem.",
"function": "minima",
"maintenance_instruction": "Id qui est qui necessitatibus. Facilis rerum necessitatibus voluptatum voluptatem accusamus praesentium cupiditate.",
"origin": "Macao",
"buy_price": 163.69,
"appdata": "a:1:{s:3:\"key\";s:10:\"laboriosam\";}",
"fields_data": "a:1:{s:5:\"field\";s:3:\"qui\";}",
"parts_data": "a:1:{s:4:\"part\";s:7:\"officia\";}",
"created_at": "2026-08-14T12:25:12.000000Z",
"updated_at": "2026-08-14T12:25:12.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\": \"bljalbi\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"ewlzhqfygtgwblm\",
\"notes\": \"rjwu\",
\"purchase_date\": \"2026-08-14T14:25:12\",
\"warranty_months\": 36,
\"warranty_info\": \"soiypnmppwsiaqhzvp\",
\"function\": \"yzguzzrdiqrd\",
\"maintenance_instruction\": \"ceroqdosuocnwixb\",
\"origin\": \"naj\",
\"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": "bljalbi",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "ewlzhqfygtgwblm",
"notes": "rjwu",
"purchase_date": "2026-08-14T14:25:12",
"warranty_months": 36,
"warranty_info": "soiypnmppwsiaqhzvp",
"function": "yzguzzrdiqrd",
"maintenance_instruction": "ceroqdosuocnwixb",
"origin": "naj",
"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' => 'bljalbi',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'ewlzhqfygtgwblm',
'notes' => 'rjwu',
'purchase_date' => '2026-08-14T14:25:12',
'warranty_months' => 36,
'warranty_info' => 'soiypnmppwsiaqhzvp',
'function' => 'yzguzzrdiqrd',
'maintenance_instruction' => 'ceroqdosuocnwixb',
'origin' => 'naj',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 2077,
"name": "eum",
"label": "quia",
"type_id": 2610,
"type": {
"id": 2610,
"name": "quisquam"
},
"location_id": 4212,
"status": "unavailable",
"description": "Vero et sit officia optio ut deserunt libero.",
"is_part": false,
"mountable": true,
"manufacturer": "Walter-Emmerich",
"position": "eum",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/002233?text=possimus",
"data_ports": 5,
"serialnumber1": "b4f5fe48-d9d7-3ae6-912f-98c54c419d17",
"serialnumber2": "7ac42193-e981-3f03-ab0b-cc82ef57e355",
"service_tag": "5d410976-f526-3e02-8fb6-18f98e45801a",
"comments": "Sequi voluptatum vel error corporis. Beatae qui doloremque nemo facere minus autem ab. Ad velit est non qui et atque odio quae.",
"notes": "Eligendi officiis quibusdam corporis asperiores. A velit eaque cupiditate. Aut voluptatem atque qui id consectetur et.",
"purchase_date": "1979-06-17",
"warranty_months": 30,
"warranty_info": "Delectus nemo officiis ea dolor magni.",
"function": "et",
"maintenance_instruction": "Doloribus ut praesentium aperiam vel adipisci. Accusamus laborum esse amet ut nesciunt tempora consectetur. Nesciunt quia aut qui enim odit quos.",
"origin": "Cayman Islands",
"buy_price": 707.61,
"appdata": "a:1:{s:3:\"key\";s:5:\"ipsam\";}",
"fields_data": "a:1:{s:5:\"field\";s:8:\"suscipit\";}",
"parts_data": "a:1:{s:4:\"part\";s:6:\"magnam\";}",
"created_at": "2026-08-14T12:25:13.000000Z",
"updated_at": "2026-08-14T12:25:13.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\": \"zlhlcmouuebsfbnzgps\",
\"serialnumber1\": \"SN123456789\",
\"serialnumber2\": \"SN987654321\",
\"service_tag\": \"ST-001122\",
\"comments\": \"sczehuoqqjfnp\",
\"notes\": \"wngocvjzmuhwku\",
\"purchase_date\": \"2026-08-14T14:25:13\",
\"warranty_months\": 36,
\"warranty_info\": \"bwfngptelapsbq\",
\"function\": \"hjinttmxj\",
\"maintenance_instruction\": \"iy\",
\"origin\": \"oy\",
\"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": "zlhlcmouuebsfbnzgps",
"serialnumber1": "SN123456789",
"serialnumber2": "SN987654321",
"service_tag": "ST-001122",
"comments": "sczehuoqqjfnp",
"notes": "wngocvjzmuhwku",
"purchase_date": "2026-08-14T14:25:13",
"warranty_months": 36,
"warranty_info": "bwfngptelapsbq",
"function": "hjinttmxj",
"maintenance_instruction": "iy",
"origin": "oy",
"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' => 'zlhlcmouuebsfbnzgps',
'serialnumber1' => 'SN123456789',
'serialnumber2' => 'SN987654321',
'service_tag' => 'ST-001122',
'comments' => 'sczehuoqqjfnp',
'notes' => 'wngocvjzmuhwku',
'purchase_date' => '2026-08-14T14:25:13',
'warranty_months' => 36,
'warranty_info' => 'bwfngptelapsbq',
'function' => 'hjinttmxj',
'maintenance_instruction' => 'iy',
'origin' => 'oy',
'buy_price' => 2500.0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 2078,
"name": "qui",
"label": "reiciendis",
"type_id": 2611,
"type": {
"id": 2611,
"name": "et"
},
"location_id": 4213,
"status": "in_use",
"description": "Voluptas sint consequuntur aliquid qui est.",
"is_part": false,
"mountable": true,
"manufacturer": "Berge-Steuber",
"position": "eveniet",
"size": 0,
"image": "https://via.placeholder.com/640x480.png/0066bb?text=est",
"data_ports": 4,
"serialnumber1": "42a96ba2-da65-3d85-bcc3-9eec15a52387",
"serialnumber2": "9a23ca89-c991-3f8a-9c78-681d8db4045d",
"service_tag": "dd060233-ecdb-33e5-bba5-30f05d5f4026",
"comments": "Fuga natus nihil necessitatibus vitae totam. Ut itaque repellendus praesentium nihil. Aut animi non natus odit. Ut voluptas molestiae dolor laboriosam cumque.",
"notes": "Iure voluptatum aperiam aut. Et id ea similique iste nam cum officiis. Mollitia sint consectetur doloremque ducimus.",
"purchase_date": "2002-11-02",
"warranty_months": 14,
"warranty_info": "Sunt sunt odit itaque reiciendis fuga.",
"function": "soluta",
"maintenance_instruction": "Quis molestias distinctio commodi occaecati. Reprehenderit non et quisquam quidem aliquam provident. Voluptas aut praesentium aut distinctio consectetur explicabo.",
"origin": "Uzbekistan",
"buy_price": 617.6,
"appdata": "a:1:{s:3:\"key\";s:2:\"id\";}",
"fields_data": "a:1:{s:5:\"field\";s:7:\"aliquam\";}",
"parts_data": "a:1:{s:4:\"part\";s:4:\"iste\";}",
"created_at": "2026-08-14T12:25:15.000000Z",
"updated_at": "2026-08-14T12:25:15.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": 7649,
"username": "ylindgren",
"email": "[email protected]",
"name": "Lindsey Bailey",
"firstname": "Lindsey",
"lastname": "Bailey",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/fa15affceffa6e85e168fece4ee4dd69?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/fa15affceffa6e85e168fece4ee4dd69?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": 7650,
"username": "ihaley",
"email": "[email protected]",
"name": "Gage Cremin",
"firstname": "Gage",
"lastname": "Cremin",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/681874c88bfaeccb442b3b43f0e4beea?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/681874c88bfaeccb442b3b43f0e4beea?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": 7651,
"username": "hkertzmann",
"email": "[email protected]",
"name": "Wellington Bernhard",
"firstname": "Wellington",
"lastname": "Bernhard",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/fe777da16bee180766af669a958eb9ad?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/fe777da16bee180766af669a958eb9ad?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": 7652,
"username": "hahn.velva",
"email": "[email protected]",
"name": "Rashad Roberts",
"firstname": "Rashad",
"lastname": "Roberts",
"devices": [],
"orders": [],
"gender": "0",
"avatar": "//www.gravatar.com/avatar/5251de8a53a6a26ef31f163ff863c01a?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/5251de8a53a6a26ef31f163ff863c01a?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": 7653,
"username": "valentina96",
"email": "[email protected]",
"name": "Barry Schoen",
"firstname": "Barry",
"lastname": "Schoen",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/4788c16ead38d41c23bd4db020739b0a?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/4788c16ead38d41c23bd4db020739b0a?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": 7654,
"username": "lou.jakubowski",
"email": "[email protected]",
"name": "Marge Rodriguez",
"firstname": "Marge",
"lastname": "Rodriguez",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/06c7e02c7e8ca36a81bbe641c7e22d49?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/06c7e02c7e8ca36a81bbe641c7e22d49?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\": [
6
],
\"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": [
6
],
"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' => [
6,
],
'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": 7732,
"name": null,
"description": "Itaque earum qui saepe expedita in.",
"item_id": 1409,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 24,
"port_index": 29,
"port_mode": "access",
"port_label": "ducimus",
"user_label": "voluptatem",
"speed": "100",
"high_speed": "10000",
"if_type": "179",
"physaddress": "2A:E2:9A:2E:25:6B",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 8738,
"ifOutUcastPkts": 4754,
"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-08-14 14:25:18",
"updated_at": "2026-08-14 14:25:18"
},
{
"id": 7733,
"name": null,
"description": "Ducimus asperiores dolores libero eos.",
"item_id": 1410,
"colocation_id": 0,
"connected_item": null,
"connected_port": null,
"port_number": 12,
"port_index": 53,
"port_mode": "trunk",
"port_label": "assumenda",
"user_label": "et",
"speed": "1000",
"high_speed": "1000",
"if_type": "202",
"physaddress": "D8:0E:5F:96:F6:C2",
"pullable": 0,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 963,
"ifOutUcastPkts": 3362,
"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-08-14 14:25:21",
"updated_at": "2026-08-14 14:25: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/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": 7734,
"name": null,
"description": "A et molestiae nemo.",
"item": {
"id": 1411,
"name": null,
"label": "at",
"type_id": 2616,
"location_id": 4219,
"status": "available",
"description": "Aut sit numquam quia saepe nesciunt voluptatum in.",
"is_part": false,
"mountable": true,
"manufacturer": "Beier Ltd",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN534LF",
"serialnumber2": null,
"service_tag": "ST407RG",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:25:21.000000Z",
"updated_at": "2026-08-14T12:25:21.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 14,
"port_index": 42,
"port_mode": "trunk",
"port_label": "minus",
"user_label": "at",
"speed": "1000",
"high_speed": "100",
"if_type": "180",
"physaddress": "24:BB:E7:5D:FD:2B",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "up",
"type": "",
"ifInUcastPkts": 1561,
"ifOutUcastPkts": 6185,
"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-08-14 14:25:23",
"updated_at": "2026-08-14 14:25: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 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": 7735,
"name": null,
"description": "Fugit quae sit debitis.",
"item": null,
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 13,
"port_index": 38,
"port_mode": "trunk",
"port_label": "aut",
"user_label": "quae",
"speed": "1000",
"high_speed": "10000",
"if_type": "63",
"physaddress": "13:F6:18:43:46:81",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 9062,
"ifOutUcastPkts": 9567,
"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-08-14 14:25:26",
"updated_at": "2026-08-14 14:25: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 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": 7736,
"name": null,
"description": "Saepe ut omnis cupiditate architecto molestiae.",
"item": null,
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 30,
"port_index": 19,
"port_mode": "access",
"port_label": "nulla",
"user_label": "sed",
"speed": "1000",
"high_speed": "100",
"if_type": "36",
"physaddress": "9D:3B:EE:77:84:55",
"pullable": 0,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 2751,
"ifOutUcastPkts": 1625,
"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-08-14 14:25:29",
"updated_at": "2026-08-14 14:25:29"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 7737,
"name": null,
"description": "Incidunt est id omnis repellendus.",
"item": {
"id": 1414,
"name": null,
"label": "commodi",
"type_id": 2622,
"location_id": 4225,
"status": "available",
"description": "Laudantium ducimus ut quia nostrum.",
"is_part": false,
"mountable": true,
"manufacturer": "Franecki-Hayes",
"position": null,
"size": 9,
"image": null,
"data_ports": 0,
"serialnumber1": "SN333IZ",
"serialnumber2": null,
"service_tag": "ST037VO",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:25:29.000000Z",
"updated_at": "2026-08-14T12:25:29.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 27,
"port_index": 39,
"port_mode": "trunk",
"port_label": "et",
"user_label": "quia",
"speed": "1000",
"high_speed": "1000",
"if_type": "133",
"physaddress": "02:50:A6:D8:5D:D5",
"pullable": 0,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "down",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 7480,
"ifOutUcastPkts": 7129,
"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-08-14 14:25:32",
"updated_at": "2026-08-14 14:25:32"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 7738,
"name": null,
"description": "Sunt saepe et velit hic asperiores eveniet at.",
"item": {
"id": 1415,
"name": null,
"label": "aliquid",
"type_id": 2624,
"location_id": 4227,
"status": "available",
"description": "Laborum consectetur cupiditate quis non quo expedita asperiores.",
"is_part": false,
"mountable": true,
"manufacturer": "Jacobson, Waters and Hill",
"position": null,
"size": 8,
"image": null,
"data_ports": 0,
"serialnumber1": "SN047NQ",
"serialnumber2": null,
"service_tag": "ST676JA",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:25:32.000000Z",
"updated_at": "2026-08-14T12:25:32.000000Z"
},
"colocation": null,
"connected_item": null,
"connected_port": null,
"port_number": 33,
"port_index": 87,
"port_mode": "trunk",
"port_label": "odit",
"user_label": "suscipit",
"speed": "1000",
"high_speed": "100",
"if_type": "229",
"physaddress": "AF:7A:B4:BF:42:91",
"pullable": 1,
"primary": 0,
"vlan": 0,
"vlans": [],
"opstate": "up",
"adminstate": "down",
"type": "",
"ifInUcastPkts": 9417,
"ifOutUcastPkts": 5221,
"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-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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.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": 809,
"ordernumber": 608808,
"user_id": 7676,
"status": "accepted",
"service_status": "suspended",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25:35"
},
{
"id": 810,
"ordernumber": 581567,
"user_id": 7677,
"status": "pending",
"service_status": "terminated",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25:35"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 811,
"ordernumber": 636258,
"user_id": 7678,
"status": "accepted",
"service_status": "activated",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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.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": 812,
"ordernumber": 50933,
"user_id": 7679,
"status": "pending",
"service_status": "suspended",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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.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": 813,
"ordernumber": 464722,
"user_id": 7680,
"status": "pending",
"service_status": "waiting",
"type": "Server",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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.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": 814,
"ordernumber": 545694,
"user_id": 7681,
"status": "accepted",
"service_status": "suspended",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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 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": 815,
"ordernumber": 902160,
"user_id": 7682,
"status": "pending",
"service_status": "provisioning",
"type": "Colocation",
"options": {
"autostart": true
},
"service": null,
"created_at": "2026-08-14 14:25:35",
"updated_at": "2026-08-14 14:25: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.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": 95,
"name": "Jay Parker",
"order": 1,
"parent_id": 1417,
"child_id": 1416,
"created_at": "2026-08-14 14:25:41",
"updated_at": "2026-08-14 14:25:41"
},
{
"id": 96,
"name": "Imogene Leannon",
"order": 8,
"parent_id": 1419,
"child_id": 1418,
"created_at": "2026-08-14 14:25:47",
"updated_at": "2026-08-14 14:25:47"
}
],
"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": 97,
"name": "Gunner Harvey",
"order": 1,
"parent": {
"id": 1421,
"label": "sequi",
"model": "sapiente",
"product_id": 0,
"model_id": 2103,
"parent_id": 0,
"type_id": 6,
"user_id": 7699,
"order_id": 0,
"location_id": 4239,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Metz-Gutmann",
"description": "Neque dignissimos eius id maxime sed voluptatem.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN696CC",
"serialnumber2": null,
"service_tag": "ST668KU",
"location": "Dach-Schumm",
"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": 1420,
"label": "mollitia",
"model": "beatae",
"product_id": 0,
"model_id": 2101,
"parent_id": 0,
"type_id": 2632,
"user_id": 7696,
"order_id": 0,
"location_id": 4239,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Lang and Sons",
"description": "Magni quas debitis fuga voluptatum amet ab deleniti quis.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN594EI",
"serialnumber2": null,
"service_tag": "ST982OZ",
"location": "Dach-Schumm",
"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-08-14 14:25:53",
"updated_at": "2026-08-14 14:25: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 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": 98,
"name": "Avis Roob",
"order": 4,
"parent": {
"id": 1423,
"label": "molestiae",
"model": "quo",
"product_id": 0,
"model_id": 2107,
"parent_id": 0,
"type_id": 6,
"user_id": 7705,
"order_id": 0,
"location_id": 4243,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Nitzsche and Sons",
"description": "Officia non voluptas tempora nam cupiditate ea quas dolores.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN396UJ",
"serialnumber2": null,
"service_tag": "ST303JS",
"location": "Lubowitz-Lockman",
"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-08-14 14:25:58",
"updated_at": "2026-08-14 14:25:58"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 99,
"name": "Chaz Haley",
"order": 4,
"parent": {
"id": 1425,
"label": "praesentium",
"model": "non",
"product_id": 0,
"model_id": 2111,
"parent_id": 0,
"type_id": 6,
"user_id": 7711,
"order_id": 0,
"location_id": 4247,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Nicolas, Thompson and Robel",
"description": "Iste aliquid et recusandae eveniet reprehenderit aut.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN648JL",
"serialnumber2": null,
"service_tag": "ST037TK",
"location": "Crona, Walker and Quitzon",
"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": 1424,
"label": "optio",
"model": "est",
"product_id": 0,
"model_id": 2109,
"parent_id": 0,
"type_id": 2638,
"user_id": 7708,
"order_id": 0,
"location_id": 4247,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Walsh, Rodriguez and Huels",
"description": "Ut a sed quod ipsum qui.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN333MQ",
"serialnumber2": null,
"service_tag": "ST755XY",
"location": "Crona, Walker and Quitzon",
"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-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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 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": 2641,
"name": "atque",
"description": "Impedit nesciunt consequatur eligendi dolorum laborum molestias ut.",
"hardware": 0,
"software": 0,
"predefined": 1,
"color": "navy",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26:04"
},
{
"id": 2642,
"name": "molestias",
"description": "Repellat dolorum et in voluptatem consequatur pariatur neque.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "teal",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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/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": 2643,
"name": "quaerat",
"description": "Voluptatem ad cum voluptatum eum.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "blue",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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 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": 2644,
"name": "recusandae",
"description": "Aut sunt voluptate sed architecto.",
"hardware": 1,
"software": 0,
"predefined": 0,
"color": "olive",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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 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": 2645,
"name": "consequatur",
"description": "Nesciunt porro accusantium nihil recusandae ab ut voluptas.",
"hardware": 1,
"software": 0,
"predefined": 1,
"color": "aqua",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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 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": 84,
"title": "Mrs. Berneice Kuphal IV"
},
{
"id": 85,
"title": "Earlene Aufderhar"
}
],
"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": 489,
"name": "consequatur.sit.inventore",
"display_name": "Dolly Klein",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26:04"
},
{
"id": 490,
"name": "distinctio.illo.adipisci",
"display_name": "Imelda Carter",
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26: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.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": 86,
"title": "Preston Spencer Sr.",
"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": 87,
"title": "Pierce Wolff",
"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": 88,
"title": "Tate Carroll",
"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": 1426,
"model_id": 2113,
"parent_id": 0,
"type_id": 2646,
"user_id": 7714,
"location_id": 4249,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"model": "molestiae",
"manufacturer": "Bergstrom, Medhurst and Marvin",
"serialnumber1": "SN405ZP",
"serialnumber2": null,
"service_tag": "ST781GS",
"comments": null,
"label": "dolores",
"description": "Nobis tenetur quae quia ut.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:04",
"updated_at": "2026-08-14 14:26:04"
},
{
"id": 1427,
"model_id": 2115,
"parent_id": 0,
"type_id": 2648,
"user_id": 7717,
"location_id": 4251,
"rack_id": 0,
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"model": "voluptates",
"manufacturer": "Beer, Upton and Witting",
"serialnumber1": "SN804BB",
"serialnumber2": null,
"service_tag": "ST995XG",
"comments": null,
"label": "nulla",
"description": "Tempore voluptas magni quis excepturi nobis.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:07",
"updated_at": "2026-08-14 14:26:07"
}
],
"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": 1428,
"model": {
"id": 2117,
"name": "voluptas",
"label": null,
"type_id": 2650,
"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-08-14T12:26:13.000000Z",
"updated_at": "2026-08-14T12:26:13.000000Z"
},
"user": {
"id": 7720,
"username": "forest83",
"email": "[email protected]",
"name": "Megane Watsica",
"firstname": "Megane",
"lastname": "Watsica",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/bdb34f86160bf12c18e5b96a3fb56a56?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/bdb34f86160bf12c18e5b96a3fb56a56?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": 2650,
"name": "dolorum",
"description": "Soluta et harum rerum nobis consequatur esse.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "green",
"created_at": "2026-08-14 14:26:10",
"updated_at": "2026-08-14 14:26:10"
},
"parent": null,
"location": {
"id": 4253,
"app_id": null,
"name": "Herman, Simonis and Hudson",
"address": "689 Moen Field Suite 895\nWebsterhaven, SD 21331",
"city": "Caryton",
"state": "Indiana",
"description": "Temporibus blanditiis porro veritatis doloremque aut alias. Quo soluta quibusdam et quidem est omnis. Sit ut expedita voluptas libero quibusdam autem. Dignissimos est molestiae consequuntur reiciendis.",
"notes": "Ut id corporis aliquam sed. Velit aut et natus et illum. Nobis atque eum quasi ratione qui alias dolores. Laborum corporis hic amet ut rerum illum.",
"emergency": "0",
"phone": "254-587-0932",
"flag": "Germany.png",
"created_at": "2026-08-14 14:26:13",
"updated_at": "2026-08-14 14:26:13"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Rogahn-Smitham",
"serialnumber1": "SN450MQ",
"serialnumber2": null,
"service_tag": "ST140OZ",
"comments": null,
"label": "ab",
"description": "Deleniti earum et id ipsa.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:10",
"updated_at": "2026-08-14 14:26: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.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": 1429,
"model": {
"id": 2119,
"name": "perferendis",
"label": null,
"type_id": 2652,
"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-08-14T12:26:16.000000Z",
"updated_at": "2026-08-14T12:26:16.000000Z"
},
"user": {
"id": 7723,
"username": "cthompson",
"email": "[email protected]",
"name": "Gail Howe",
"firstname": "Gail",
"lastname": "Howe",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/d8e3198374ac0a92c86bc047db1cb388?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/d8e3198374ac0a92c86bc047db1cb388?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": 2652,
"name": "omnis",
"description": "Non assumenda sapiente omnis.",
"hardware": 0,
"software": 0,
"predefined": 0,
"color": "aqua",
"created_at": "2026-08-14 14:26:13",
"updated_at": "2026-08-14 14:26:13"
},
"parent": null,
"location": {
"id": 4255,
"app_id": null,
"name": "Cronin, Wuckert and Hammes",
"address": "33814 Yolanda Shoals\nOdellland, CO 38857",
"city": "Beattymouth",
"state": "Iowa",
"description": "Magnam qui in repellat. Qui deleniti illo illum. Dolores laboriosam magnam dicta porro dignissimos aut rem. Et quibusdam consequatur est quia quia.",
"notes": "Magnam ipsam est tempore omnis dolorum qui est veritatis. Dolore fugiat ea dolorum modi. Ut numquam esse qui qui aut. Facilis qui aut magni ea qui.",
"emergency": "0",
"phone": "1-458-322-2433",
"flag": "Germany.png",
"created_at": "2026-08-14 14:26:15",
"updated_at": "2026-08-14 14:26:15"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 1,
"mountable": 0,
"manufacturer": "Howell Inc",
"serialnumber1": "SN847ZX",
"serialnumber2": null,
"service_tag": "ST740LG",
"comments": null,
"label": "maiores",
"description": "Ad nihil odit quam.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:13",
"updated_at": "2026-08-14 14:26: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
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": 1430,
"model": {
"id": 2121,
"name": "quisquam",
"label": null,
"type_id": 2654,
"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-08-14T12:26:18.000000Z",
"updated_at": "2026-08-14T12:26:18.000000Z"
},
"user": {
"id": 7726,
"username": "ward.loraine",
"email": "[email protected]",
"name": "Natasha Fadel",
"firstname": "Natasha",
"lastname": "Fadel",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/4cfeeeadf14b0f53305ad5d8260d9539?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/4cfeeeadf14b0f53305ad5d8260d9539?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": 2654,
"name": "possimus",
"description": "Explicabo consequuntur deserunt mollitia consequatur consectetur commodi autem.",
"hardware": 0,
"software": 1,
"predefined": 0,
"color": "green",
"created_at": "2026-08-14 14:26:16",
"updated_at": "2026-08-14 14:26:16"
},
"parent": null,
"location": {
"id": 4257,
"app_id": null,
"name": "McLaughlin-Berge",
"address": "1185 Schinner Island Suite 542\nMacstad, IL 52728",
"city": "West Luisa",
"state": "Iowa",
"description": "Eveniet amet nostrum sapiente fugit et. Quis ut recusandae ipsum tempora pariatur cumque provident. Modi rerum officiis non omnis ut non quia.",
"notes": "Quia amet voluptatem modi accusantium. Soluta iusto officiis iste porro. Voluptate praesentium optio id debitis qui. Fugit atque nulla eaque porro.",
"emergency": "1",
"phone": "912-574-4028",
"flag": "Germany.png",
"created_at": "2026-08-14 14:26:18",
"updated_at": "2026-08-14 14:26:18"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"manufacturer": "Swaniawski, Labadie and Brekke",
"serialnumber1": "SN474WX",
"serialnumber2": null,
"service_tag": "ST682HK",
"comments": null,
"label": "veritatis",
"description": "Est tempora qui sed qui reprehenderit saepe.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:16",
"updated_at": "2026-08-14 14:26:16"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Assign 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": 1431,
"model": {
"id": 2123,
"name": "est",
"label": null,
"type_id": 2656,
"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-08-14T12:26:21.000000Z",
"updated_at": "2026-08-14T12:26:21.000000Z"
},
"user": {
"id": 7729,
"username": "nicklaus08",
"email": "[email protected]",
"name": "Aniyah Kihn",
"firstname": "Aniyah",
"lastname": "Kihn",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/c44d5566dec13fa3052f1132b8fab7d5?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/c44d5566dec13fa3052f1132b8fab7d5?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": 2656,
"name": "consequuntur",
"description": "Dolor nulla aperiam officiis nulla nihil ut.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "blue",
"created_at": "2026-08-14 14:26:18",
"updated_at": "2026-08-14 14:26:18"
},
"parent": null,
"location": {
"id": 4259,
"app_id": null,
"name": "Padberg Group",
"address": "10665 Kozey Extensions\nEast Christopher, NM 00161",
"city": "Russelville",
"state": "Florida",
"description": "Est iste facilis nisi id modi et. Ut dignissimos recusandae perferendis nemo. Dolores voluptas neque vel voluptatibus impedit debitis et velit. Sequi veniam recusandae praesentium voluptates possimus in labore. Eligendi qui et sapiente pariatur.",
"notes": "Beatae dolores recusandae perspiciatis debitis enim est quod. Voluptatem ipsam est dolores rerum. Suscipit et facere modi accusamus doloribus ab.",
"emergency": "0",
"phone": "443-849-2122",
"flag": "Canada.png",
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
},
"rack": null,
"metadata": [],
"position": null,
"image": null,
"is_part": 0,
"mountable": 1,
"manufacturer": "Gottlieb Ltd",
"serialnumber1": "SN947WE",
"serialnumber2": null,
"service_tag": "ST103HU",
"comments": null,
"label": "ratione",
"description": "Dicta quaerat consequatur officia harum.",
"purchase_date": "2025-08-14",
"warranty_months": 24,
"warranty_info": null,
"status": "available",
"function": null,
"origin": null,
"buy_price": 0,
"appdata": false,
"notes": null,
"created_at": "2026-08-14 14:26:18",
"updated_at": "2026-08-14 14:26: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": 177,
"related_type": null,
"element": "dropdown",
"group": "Base",
"slug": "consectetur.beatae.exercitationem",
"label": "Florida Beer",
"options": {
"ut qui eum eos corrupti": "ut qui eum eos corrupti"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"illum",
"corrupti",
"cupiditate",
"repellendus",
"rerum"
],
"order": 1,
"types": [],
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
},
{
"id": 178,
"related_type": null,
"element": "textarea",
"group": "Base",
"slug": "magnam.ut.earum",
"label": "Madonna Kirlin PhD",
"options": {
"deserunt est ab deleniti laborum": "deserunt est ab deleniti laborum"
},
"predefined": 1,
"hidden": 1,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"commodi",
"et",
"et",
"et",
"et"
],
"order": 28,
"types": [],
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26: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/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": 179,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "quas.deleniti.eum",
"label": "Francesca Abernathy",
"options": {
"est debitis recusandae nemo sit": "est debitis recusandae nemo sit"
},
"predefined": 1,
"hidden": 1,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 0,
"encrypted": 0,
"additional_rules": [
"est",
"non",
"quos",
"tempora",
"itaque"
],
"order": 100,
"values": [],
"types": [],
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 180,
"related_type": null,
"element": "dropdown",
"group": "Base",
"slug": "harum.ad.excepturi",
"label": "Dr. Alexandre Thiel",
"options": {
"minima dignissimos qui delectus nihil": "minima dignissimos qui delectus nihil"
},
"predefined": 0,
"hidden": 1,
"provisionable": 1,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 0,
"sortable": 1,
"encrypted": 0,
"additional_rules": [
"asperiores",
"nostrum",
"nisi",
"unde",
"doloremque"
],
"order": 40,
"values": [],
"types": [],
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 181,
"related_type": null,
"element": "text",
"group": "Base",
"slug": "quo.maxime.adipisci",
"label": "Dominique Beier",
"options": {
"necessitatibus omnis quaerat dolore cumque": "necessitatibus omnis quaerat dolore cumque"
},
"predefined": 1,
"hidden": 0,
"provisionable": 0,
"combined": 0,
"filterable": 0,
"filterable_type": null,
"unique": 1,
"sortable": 1,
"encrypted": 1,
"additional_rules": [
"dicta",
"quos",
"eum",
"tempore",
"nostrum"
],
"order": 83,
"values": [],
"types": [],
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 490,
"name": "repellat",
"description": "Aut quas quia incidunt libero.",
"item_id": 1432,
"colocation_id": 0,
"port_number": 8,
"port_label": "aut",
"user_label": "qui",
"outlet_state": "down",
"connected_item": null,
"connected_port": null,
"power_usage": 83,
"power_usage_units": "Amps",
"power_usage_value": 83,
"power_usage_unit": "amps",
"power_usage_label": "83 Amps",
"created_at": "2026-08-14 14:26:21",
"updated_at": "2026-08-14 14:26:21"
},
{
"id": 491,
"name": "asperiores",
"description": "Dolor molestiae quod omnis non ipsum aut laudantium.",
"item_id": 1433,
"colocation_id": 0,
"port_number": 25,
"port_label": "voluptatibus",
"user_label": "voluptas",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 9,
"power_usage_units": "Amps",
"power_usage_value": 9,
"power_usage_unit": "amps",
"power_usage_label": "9 Amps",
"created_at": "2026-08-14 14:26:27",
"updated_at": "2026-08-14 14:26: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/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": 492,
"name": "id",
"description": "Ut eveniet doloremque maiores molestiae aut sunt.",
"item": {
"id": 1434,
"name": null,
"label": "omnis",
"type_id": 2662,
"location_id": 4269,
"status": "available",
"description": "Neque aut illum magni possimus sit eveniet voluptatibus et.",
"is_part": false,
"mountable": true,
"manufacturer": "Dibbert, Altenwerth and Hettinger",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN785PM",
"serialnumber2": null,
"service_tag": "ST801OP",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:26:33.000000Z",
"updated_at": "2026-08-14T12:26:33.000000Z"
},
"colocation": null,
"port_number": 21,
"port_label": "rerum",
"user_label": "quod",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 89,
"power_usage_units": "Amps",
"power_usage_value": 89,
"power_usage_unit": "amps",
"power_usage_label": "89 Amps",
"created_at": "2026-08-14 14:26:33",
"updated_at": "2026-08-14 14:26:33"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 493,
"name": "aut",
"description": "Reprehenderit asperiores excepturi quam possimus esse velit.",
"item": null,
"colocation": null,
"port_number": 37,
"port_label": "velit",
"user_label": "magni",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 47,
"power_usage_units": "Amps",
"power_usage_value": 47,
"power_usage_unit": "amps",
"power_usage_label": "47 Amps",
"created_at": "2026-08-14 14:26:39",
"updated_at": "2026-08-14 14:26:39"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 494,
"name": "soluta",
"description": "Laudantium quia expedita facilis ducimus id.",
"item": null,
"colocation": null,
"port_number": 33,
"port_label": "et",
"user_label": "ratione",
"outlet_state": "outletOn",
"connected_item": null,
"connected_port": null,
"power_usage": 31,
"power_usage_units": "Amps",
"power_usage_value": 31,
"power_usage_unit": "amps",
"power_usage_label": "31 Amps",
"created_at": "2026-08-14 14:26:46",
"updated_at": "2026-08-14 14:26: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.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": 495,
"name": "non",
"description": "Aliquid et ut sit dolores doloribus consequuntur autem.",
"item": {
"id": 1437,
"name": null,
"label": "delectus",
"type_id": 2668,
"location_id": 4281,
"status": "available",
"description": "Cupiditate voluptatem rerum illo nihil error explicabo.",
"is_part": false,
"mountable": true,
"manufacturer": "Grimes, Funk and Douglas",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN676OB",
"serialnumber2": null,
"service_tag": "ST648ZI",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:26:52.000000Z",
"updated_at": "2026-08-14T12:26:52.000000Z"
},
"colocation": null,
"port_number": 23,
"port_label": "voluptatem",
"user_label": "delectus",
"outlet_state": "outletOff",
"connected_item": null,
"connected_port": null,
"power_usage": 53,
"power_usage_units": "Amps",
"power_usage_value": 53,
"power_usage_unit": "amps",
"power_usage_label": "53 Amps",
"created_at": "2026-08-14 14:26:52",
"updated_at": "2026-08-14 14:26: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.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": 496,
"name": "ratione",
"description": "Sed autem accusantium reiciendis sit id.",
"item": null,
"colocation": null,
"port_number": 8,
"port_label": "consequuntur",
"user_label": "alias",
"outlet_state": "up",
"connected_item": null,
"connected_port": null,
"power_usage": 4,
"power_usage_units": "Amps",
"power_usage_value": 4,
"power_usage_unit": "amps",
"power_usage_label": "4 Amps",
"created_at": "2026-08-14 14:26:58",
"updated_at": "2026-08-14 14:26:58"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 497,
"name": "quia",
"description": "Aut minima ea consequatur.",
"item": {
"id": 1439,
"name": null,
"label": "porro",
"type_id": 2672,
"location_id": 4289,
"status": "available",
"description": "Earum reprehenderit nam nesciunt similique nihil dicta.",
"is_part": false,
"mountable": true,
"manufacturer": "Kiehn, Blick and Wehner",
"position": null,
"size": 1,
"image": null,
"data_ports": 0,
"serialnumber1": "SN412YM",
"serialnumber2": null,
"service_tag": "ST445FD",
"comments": null,
"notes": null,
"purchase_date": "2025-08-14",
"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-08-14T12:27:05.000000Z",
"updated_at": "2026-08-14T12:27:05.000000Z"
},
"colocation": null,
"port_number": 11,
"port_label": "sit",
"user_label": "illo",
"outlet_state": "down",
"connected_item": null,
"connected_port": null,
"power_usage": 89,
"power_usage_units": "Amps",
"power_usage_value": 89,
"power_usage_unit": "amps",
"power_usage_label": "89 Amps",
"created_at": "2026-08-14 14:27:05",
"updated_at": "2026-08-14 14:27:05"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete 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": 886,
"item_id": 1440,
"name": "quo",
"class": "Power Supply",
"type": "Thermal",
"unit": "Percent",
"index": "Thermal",
"reading": 179,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:27:13",
"updated_at": "2026-08-14 14:27:13"
},
{
"id": 887,
"item_id": 1441,
"name": "aliquid",
"class": "Fans",
"type": "Power",
"unit": "Celsius",
"index": "Power",
"reading": 205,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:27:17",
"updated_at": "2026-08-14 14:27:17"
}
],
"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": 888,
"item_id": 1442,
"name": "qui",
"class": "Fans",
"type": "Power",
"unit": "Amps",
"index": "Power",
"reading": 629,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:27:19",
"updated_at": "2026-08-14 14:27: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 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": 80,
"name": "impedit",
"type": "Server",
"default": 0,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:5:\"model\";i:1;s:11:\"description\";i:2;s:8:\"position\";i:3;s:8:\"location\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:23:\"widget_last_month_graph\";i:1;s:20:\"widget_network_ports\";i:2;s:9:\"filtering\";i:3;s:17:\"widget_last_month\";i:4;s:17:\"left_sidebar_link\";}s:5:\"power\";a:6:{i:0;s:20:\"widget_average_usage\";i:1;s:7:\"outlets\";i:2;s:23:\"widget_last_month_graph\";i:3;s:17:\"left_sidebar_link\";i:4;s:17:\"widget_last_month\";i:5;s:9:\"filtering\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"delete_rdns\";i:1;s:22:\"rdns_left_sidebar_link\";i:2;s:11:\"create_rdns\";i:3;s:11:\"update_rdns\";}}"
},
{
"id": 81,
"name": "corporis",
"type": "Server",
"default": 1,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"location\";i:1;s:5:\"model\";i:2;s:11:\"description\";i:3;s:8:\"position\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:20:\"widget_network_ports\";i:1;s:17:\"left_sidebar_link\";i:2;s:17:\"widget_last_month\";i:3;s:23:\"widget_last_month_graph\";i:4;s:9:\"filtering\";}s:5:\"power\";a:6:{i:0;s:23:\"widget_last_month_graph\";i:1;s:20:\"widget_average_usage\";i:2;s:17:\"widget_last_month\";i:3;s:9:\"filtering\";i:4;s:17:\"left_sidebar_link\";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:\"update_rdns\";i:1;s:22:\"rdns_left_sidebar_link\";i:2;s:11:\"delete_rdns\";i:3;s:11:\"create_rdns\";}}"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/service-access-levels?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/service-access-levels",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Devices
List Devices
requires authentication
Returns a paginated list of devices.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/devices?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/devices'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/devices';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 1443,
"label": "officia",
"model": "molestiae",
"product_id": 0,
"model_id": 2147,
"parent_id": 0,
"type_id": 2680,
"user_id": 7797,
"order_id": 824,
"location_id": 4299,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Collins, Nitzsche and Block",
"description": "Aliquid doloribus non non cupiditate sit minima et.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN068MH",
"serialnumber2": null,
"service_tag": "ST588EL",
"location": "O'Conner, Hansen and Conn",
"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": 1444,
"label": "nemo",
"model": "et",
"product_id": 0,
"model_id": 2149,
"parent_id": 0,
"type_id": 2682,
"user_id": 7804,
"order_id": 825,
"location_id": 4303,
"rack_id": 0,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Prosacco-Blick",
"description": "Tenetur id rerum et enim aspernatur magni sit.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN428GG",
"serialnumber2": null,
"service_tag": "ST134GB",
"location": "Krajcik 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
}
],
"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": 1445,
"product_id": 0,
"model_id": 2151,
"parent_id": 0,
"type_id": 2684,
"user_id": 7811,
"order_id": 826,
"location_id": 4307,
"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": "Kerluke Group",
"serialnumber1": "SN616ED",
"serialnumber2": null,
"service_tag": "ST849TS",
"comments": null,
"label": "quis",
"description": "Dolorum distinctio ullam itaque sit possimus blanditiis enim ullam.",
"ip_addresses": [],
"purchase_date": "2025-08-14",
"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": 2684,
"name": "ut",
"description": "Repellat sit et sed perferendis.",
"hardware": 1,
"software": 0,
"predefined": 1,
"color": "white",
"created_at": "2026-08-14 14:27:31",
"updated_at": "2026-08-14 14:27:31"
},
"model": {
"id": 2151,
"name": "fuga",
"label": null,
"type_id": 2684,
"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-08-14T12:27:36.000000Z",
"updated_at": "2026-08-14T12:27:36.000000Z"
},
"user": {
"id": 7811,
"username": "yratke",
"email": "[email protected]",
"name": "Alexander Howe",
"firstname": "Alexander",
"lastname": "Howe",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/a30a007d28b7392b773999cf36d77a02?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/a30a007d28b7392b773999cf36d77a02?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": 4307,
"app_id": null,
"name": "Sanford, Fritsch and Hyatt",
"address": "542 Okuneva Plain Apt. 826\nSouth Augustusmouth, TN 80239-2652",
"city": "Twilaside",
"state": "Wyoming",
"description": "Eligendi natus doloribus mollitia quos quae harum. Voluptatem labore ducimus molestias unde eos sapiente. Enim alias pariatur perspiciatis accusamus. Vel sint esse laborum corporis nihil.",
"notes": "Autem quia aut quo dolores quaerat ut. Et qui ipsum eos maxime et. Nihil neque nihil explicabo atque vero commodi quia.",
"emergency": "0",
"phone": "(669) 800-9893",
"flag": "Canada.png",
"created_at": "2026-08-14 14:27:33",
"updated_at": "2026-08-14 14:27:33"
},
"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": 1446,
"product_id": 0,
"model_id": 2153,
"parent_id": 0,
"type_id": 2686,
"user_id": 7818,
"order_id": 827,
"location_id": 4311,
"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": "Prohaska, Langosh and Mayer",
"serialnumber1": "SN444WD",
"serialnumber2": null,
"service_tag": "ST272IF",
"comments": null,
"label": "sunt",
"description": "Vitae vel nesciunt ullam iusto et voluptatem est.",
"ip_addresses": [],
"purchase_date": "2025-08-14",
"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": 2686,
"name": "praesentium",
"description": "Provident ut non non vitae quaerat sint.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "aqua",
"created_at": "2026-08-14 14:27:36",
"updated_at": "2026-08-14 14:27:36"
},
"model": {
"id": 2153,
"name": "quia",
"label": null,
"type_id": 2686,
"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-08-14T12:27:41.000000Z",
"updated_at": "2026-08-14T12:27:41.000000Z"
},
"user": {
"id": 7818,
"username": "ttorphy",
"email": "[email protected]",
"name": "Raphaelle Kozey",
"firstname": "Raphaelle",
"lastname": "Kozey",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/98bd799cf4cb19968262296e2a4902e8?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/98bd799cf4cb19968262296e2a4902e8?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": 4311,
"app_id": null,
"name": "Simonis-Mertz",
"address": "46015 Sid Causeway Apt. 962\nPort Laurynview, SC 90762-2982",
"city": "West Josefafort",
"state": "Louisiana",
"description": "Saepe quis quos voluptatum alias provident. Sequi aut nihil qui voluptatibus rerum illo dolor. Nam libero delectus officia ut optio quo earum omnis.",
"notes": "Illo sapiente quod maiores minima numquam saepe corporis ad. Accusamus eligendi ipsam voluptas optio. Distinctio amet doloremque provident soluta nisi dolorum aliquid.",
"emergency": "0",
"phone": "+1-207-455-0362",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:39",
"updated_at": "2026-08-14 14:27: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.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": 1447,
"product_id": 0,
"model_id": 2155,
"parent_id": 0,
"type_id": 2688,
"user_id": 7825,
"order_id": 828,
"location_id": 4315,
"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": "Heidenreich and Sons",
"serialnumber1": "SN011OI",
"serialnumber2": null,
"service_tag": "ST865KM",
"comments": null,
"label": "repudiandae",
"description": "Deserunt consectetur esse alias qui ut ipsam ipsum officia.",
"ip_addresses": [],
"purchase_date": "2025-08-14",
"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": 2688,
"name": "culpa",
"description": "Ipsa quia vero ea dolorem sunt et delectus.",
"hardware": 1,
"software": 0,
"predefined": 1,
"color": "lime",
"created_at": "2026-08-14 14:27:41",
"updated_at": "2026-08-14 14:27:41"
},
"model": {
"id": 2155,
"name": "quis",
"label": null,
"type_id": 2688,
"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-08-14T12:27:47.000000Z",
"updated_at": "2026-08-14T12:27:47.000000Z"
},
"user": {
"id": 7825,
"username": "hackett.thomas",
"email": "[email protected]",
"name": "Savion Morissette",
"firstname": "Savion",
"lastname": "Morissette",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/0f8eea337b62f19e78107debeb416060?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/0f8eea337b62f19e78107debeb416060?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": 4315,
"app_id": null,
"name": "Zieme-Hermann",
"address": "7928 Pablo Wall Apt. 092\nMargieport, ID 50019",
"city": "South Thomasmouth",
"state": "Ohio",
"description": "Quis adipisci sit aut facere officia doloribus animi. In aut harum modi. Est magnam nihil deleniti accusantium vel animi. Consectetur numquam excepturi totam molestiae illo a.",
"notes": "Voluptatem eius sed repellendus. Qui qui quis cumque. Voluptatum modi in molestias exercitationem enim est molestiae.",
"emergency": "1",
"phone": "+1-231-464-1297",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:44",
"updated_at": "2026-08-14 14:27: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.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": 1448,
"product_id": 0,
"model_id": 2157,
"parent_id": 0,
"type_id": 2690,
"user_id": 7832,
"order_id": 829,
"location_id": 4319,
"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": "D'Amore Group",
"serialnumber1": "SN338TL",
"serialnumber2": null,
"service_tag": "ST719CV",
"comments": null,
"label": "architecto",
"description": "Beatae incidunt esse maiores qui.",
"ip_addresses": [],
"purchase_date": "2025-08-14",
"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": 2690,
"name": "magni",
"description": "Illo saepe ut ad explicabo.",
"hardware": 1,
"software": 1,
"predefined": 1,
"color": "olive",
"created_at": "2026-08-14 14:27:47",
"updated_at": "2026-08-14 14:27:47"
},
"model": {
"id": 2157,
"name": "est",
"label": null,
"type_id": 2690,
"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-08-14T12:27:53.000000Z",
"updated_at": "2026-08-14T12:27:53.000000Z"
},
"user": {
"id": 7832,
"username": "heller.cristina",
"email": "[email protected]",
"name": "Zita Zulauf",
"firstname": "Zita",
"lastname": "Zulauf",
"gender": "0",
"avatar": "//www.gravatar.com/avatar/c3308cbd5632e67b82d41a8b2b0c9cb8?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/c3308cbd5632e67b82d41a8b2b0c9cb8?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": 4319,
"app_id": null,
"name": "Jones-McKenzie",
"address": "43647 Idell Fork Apt. 217\nEast Erynburgh, MA 98255-2045",
"city": "Kirlintown",
"state": "North Dakota",
"description": "Eos voluptatem eos iusto. Odit ut dicta in dolores molestiae eos dolor est.",
"notes": "Excepturi autem molestiae esse. Eius soluta nobis iste libero unde harum. Expedita cumque fugit sed quaerat. Eum necessitatibus velit pariatur quis ut.",
"emergency": "1",
"phone": "+1-559-949-0513",
"flag": "Canada.png",
"created_at": "2026-08-14 14:27:50",
"updated_at": "2026-08-14 14:27:50"
},
"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\": [
9
],
\"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": [
9
],
"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' => [
9,
],
'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": 1192,
"name": "voluptatum temporibus et",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27:53"
},
{
"id": 1193,
"name": "beatae ipsum blanditiis",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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/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": 1194,
"name": "est praesentium amet",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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 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": 1195,
"name": "dolore provident quos",
"status": "1",
"message": "All Good!",
"installed_version": "1.0",
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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.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": 66,
"type": "ipv4",
"subnet": "10.192.228.237",
"mask": 24,
"gateway": "15.218.226.16"
},
{
"id": 67,
"type": "ipv4",
"subnet": "178.214.15.120",
"mask": 24,
"gateway": "8.90.229.12"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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/et/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/et/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/et/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": 68,
"type": "ipv4",
"subnet": "17.112.110.188",
"mask": 24,
"gateway": "114.39.29.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.Update DHCP Subnet
requires authentication
Updates an existing DHCP subnet configuration.
Example request:
curl --request PUT \
"https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"ipv4\",
\"subnet\": \"10.10.10.0\",
\"mask\": 24,
\"gateway\": \"10.10.10.1\",
\"description\": \"DHCP range for rack A\"
}"
import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/et'
payload = {
"type": "ipv4",
"subnet": "10.10.10.0",
"mask": 24,
"gateway": "10.10.10.1",
"description": "DHCP range for rack A"
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/remote-agents/cum/subnets/et';
$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": 69,
"type": "ipv4",
"subnet": "44.154.37.195",
"mask": 24,
"gateway": "253.221.189.251"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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/laborum/subnets/cum" \
--header "Authorization: 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/laborum/subnets/cum'
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/laborum/subnets/cum';
$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": 132,
"name": "quam-iso",
"iso_url": "https://www.lynch.com/delectus-nobis-ut-aliquid-eaque",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27:54"
},
{
"id": 133,
"name": "rerum-iso",
"iso_url": "https://bins.com/perferendis-dolorem-et-commodi.html",
"status": 3,
"status_label": "Finished",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27: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/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": 134,
"name": "aut-iso",
"iso_url": "http://www.kulas.com/",
"status": 3,
"status_label": "Finished",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27: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.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": 135,
"name": "consequatur-iso",
"iso_url": "http://harber.com/",
"status": 3,
"status_label": "Finished",
"created_at": "2026-08-14 14:27:55",
"updated_at": "2026-08-14 14:27: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.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": 136,
"name": "officia-iso",
"iso_url": "http://funk.com/provident-sit-suscipit-excepturi-quis",
"status": 1,
"status_label": "Waiting",
"created_at": "2026-08-14 14:27:55",
"updated_at": "2026-08-14 14:27: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 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": 287,
"template_id": 287,
"name": "ad",
"server_id": 689,
"tags": [
"iusto",
"sit",
"ut",
"praesentium",
"rerum"
],
"architecture": "x64",
"cache_folder": "temporibus",
"mirror": "http://www.goodwin.com/rerum-ut-voluptas-modi-sunt-fugit-id.html",
"edition": "fugiat",
"iso_url": "https://kilback.com/voluptatem-excepturi-qui-beatae-culpa-ipsum-dolorum-et.html",
"tftp_url": "http://kemmer.com/debitis-dicta-non-excepturi-doloribus-voluptatem",
"license": "et",
"gpxe": "Est hic nulla est animi quis.",
"disk_layout": "Aut quia quis voluptas numquam sed qui quia.",
"packages": "Occaecati vel voluptatem sint non consectetur vel.",
"post_installation": "Ab voluptatem non dolores sint dolorem non.",
"first_boot": "Placeat non et et architecto hic.",
"extras": "Porro magnam tempora magni adipisci architecto deleniti.",
"timezone": "Pacific/Pago_Pago",
"language": "xh",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 689,
"app_id": 1234,
"name": "Adalberto Tremblay",
"module": "Remote Module",
"configuration": {
"app": 1234,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "104.77.190.17",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
},
{
"id": 690,
"app_id": 1235,
"name": "Mrs. April Thiel",
"module": "Remote Module",
"configuration": {
"app": 1235,
"rebootmethod": "ipmi_easy",
"nameserver_1": "193.155.153.32",
"nameserver_2": "184.160.246.61",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "undionly.kpxe"
},
"enabled": 1
}
],
"provisioning_profiles": []
},
{
"id": 288,
"template_id": 288,
"name": "repudiandae",
"server_id": 691,
"tags": [
"velit",
"quisquam",
"similique",
"dolores",
"vel",
"corporis"
],
"architecture": "x86",
"cache_folder": "a",
"mirror": "http://www.adams.biz/quaerat-labore-enim-reiciendis.html",
"edition": "placeat",
"iso_url": "http://www.klein.com/harum-ut-atque-illo-velit",
"tftp_url": "http://www.dooley.com/numquam-nisi-consequatur-ex-enim",
"license": "natus",
"gpxe": "Est consequatur perspiciatis est minima nesciunt rerum alias.",
"disk_layout": "Voluptas veniam explicabo velit quae magnam et sed.",
"packages": "Placeat id voluptas repellendus reprehenderit et ad.",
"post_installation": "Voluptatem quod debitis quia autem voluptas debitis assumenda.",
"first_boot": "Autem deleniti porro cupiditate.",
"extras": "Laboriosam corporis nesciunt maxime sit.",
"timezone": "Antarctica/Casey",
"language": "lb",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 691,
"app_id": 1236,
"name": "Mr. Terry McKenzie MD",
"module": "Remote Module",
"configuration": {
"app": 1236,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "114.234.155.27",
"rescue_template": null,
"reinstall_template": null,
"bootloader": "vmware.kpxe"
},
"enabled": 1
},
{
"id": 692,
"app_id": 1237,
"name": "Letha Keebler",
"module": "Remote Module",
"configuration": {
"app": 1237,
"rebootmethod": "ipmi_easy_uefi",
"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": 289,
"template_id": 289,
"name": "illo",
"server_id": 693,
"tags": [
"voluptate",
"omnis",
"aut",
"quasi"
],
"architecture": "arm",
"cache_folder": "doloremque",
"mirror": "http://schaefer.biz/rerum-error-consequatur-doloribus.html",
"edition": "ut",
"iso_url": "http://www.buckridge.com/",
"tftp_url": "https://kirlin.com/distinctio-eaque-inventore-pariatur-nobis-voluptate-id.html",
"license": "quod",
"gpxe": "Quod architecto sit perspiciatis aut.",
"disk_layout": "Iure quis numquam provident nobis.",
"packages": "Atque fugit veritatis quo asperiores omnis qui aut.",
"post_installation": "Unde facere quis sed molestiae sunt rerum.",
"first_boot": "Mollitia explicabo esse ut sed.",
"extras": "Id corrupti aut fuga dolorem corrupti.",
"timezone": "Asia/Atyrau",
"language": "ak",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 693,
"app_id": 1238,
"name": "Adelia Lebsack",
"module": "Remote Module",
"configuration": {
"app": 1238,
"rebootmethod": "ipmi_easy",
"nameserver_1": "15.108.72.156",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
},
{
"id": 694,
"app_id": 1239,
"name": "Oscar Mosciski DVM",
"module": "Remote Module",
"configuration": {
"app": 1239,
"rebootmethod": "ipmi_easy_uefi",
"nameserver_1": null,
"nameserver_2": "165.190.238.247",
"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": 290,
"template_id": 290,
"name": "optio",
"server_id": 695,
"tags": [
"in",
"maiores",
"ullam",
"qui"
],
"architecture": "x64",
"cache_folder": "odit",
"mirror": "http://mckenzie.com/",
"edition": "dolorem",
"iso_url": "http://renner.com/est-rem-sunt-non-mollitia-doloribus-voluptas",
"tftp_url": "http://www.damore.com/vero-nostrum-quis-eos-maiores-ut.html",
"license": "suscipit",
"gpxe": "Ullam suscipit et mollitia autem consequuntur eum.",
"disk_layout": "Sit a expedita eos eaque enim.",
"packages": "Eum quasi aut adipisci quis.",
"post_installation": "Quo quasi amet ut quas eius in.",
"first_boot": "Quae velit vel eaque et amet.",
"extras": "Dolores impedit consequatur quaerat dolore repudiandae est.",
"timezone": "Asia/Baku",
"language": "bm",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 695,
"app_id": 1240,
"name": "Chandler Maggio MD",
"module": "Remote Module",
"configuration": {
"app": 1240,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": "179.105.207.139",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 0
},
{
"id": 696,
"app_id": 1241,
"name": "Christ Crist",
"module": "Remote Module",
"configuration": {
"app": 1241,
"rebootmethod": "manual",
"nameserver_1": "43.130.115.133",
"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.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": 291,
"template_id": 291,
"name": "tenetur",
"server_id": 697,
"tags": [
"voluptatem",
"sit",
"necessitatibus",
"voluptate",
"qui"
],
"architecture": "x86",
"cache_folder": "sit",
"mirror": "http://schaden.com/occaecati-nesciunt-quas-non-quia",
"edition": "occaecati",
"iso_url": "https://kutch.info/possimus-voluptates-illo-iusto-nobis-excepturi-non-natus.html",
"tftp_url": "https://www.mitchell.com/pariatur-enim-voluptas-illo-veritatis-et-nemo-mollitia-quod",
"license": "illum",
"gpxe": "Aliquid repudiandae sunt voluptas odio ad voluptas animi.",
"disk_layout": "Necessitatibus aut et doloremque voluptas est ut.",
"packages": "Quaerat ut iure quia.",
"post_installation": "Voluptatem possimus eos quia et nisi cupiditate consequuntur.",
"first_boot": "Expedita quaerat nobis iusto odit vel temporibus.",
"extras": "Sapiente sunt debitis quo aut molestiae deleniti excepturi.",
"timezone": "Africa/Johannesburg",
"language": "oj",
"family": "",
"is_windows": false,
"is_rescue": false,
"servers": [
{
"id": 697,
"app_id": 1242,
"name": "Dr. Shanna Murray",
"module": "Remote Module",
"configuration": {
"app": 1242,
"rebootmethod": "pdu",
"nameserver_1": "241.97.149.80",
"nameserver_2": "41.114.127.27",
"rescue_template": null,
"reinstall_template": null,
"bootloader": null
},
"enabled": 1
},
{
"id": 698,
"app_id": 1243,
"name": "Nicola Grady",
"module": "Remote Module",
"configuration": {
"app": 1243,
"rebootmethod": "pdu",
"nameserver_1": "63.44.24.142",
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "ipxe1.0.0undionly.kkpxe"
},
"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=11&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': '11',
'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' => '11',
'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": 116,
"server_id": 699,
"name": "Carlotta Zboncak",
"description": "Aliquid modi blanditiis quibusdam qui.",
"type": "disklayout",
"tag": "itaque saepe",
"tags": [
"itaque",
"saepe"
],
"data": "Qui reiciendis qui quasi libero."
},
{
"id": 117,
"server_id": 700,
"name": "Marcelino Stanton",
"description": "Modi aspernatur laudantium possimus voluptate.",
"type": "disklayout",
"tag": "sapiente tenetur",
"tags": [
"sapiente",
"tenetur"
],
"data": "Quia a qui ducimus officiis."
}
],
"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": 118,
"server_id": 701,
"name": "Janis Barton MD",
"description": "Qui nisi accusamus et non.",
"type": "postinstall",
"tag": "mollitia natus",
"tags": [
"mollitia",
"natus"
],
"data": "Recusandae aut ut dolorem dignissimos ut tempora quasi."
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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\": \"cupiditate\",
\"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": "cupiditate",
"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' => 'cupiditate',
'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": 119,
"server_id": 702,
"name": "Marion Vandervort",
"description": "Amet aperiam molestiae ducimus ullam a voluptatibus vitae.",
"type": "disklayout",
"tag": "aut et",
"tags": [
"aut",
"et"
],
"data": "Necessitatibus earum eos aut quibusdam."
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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\": \"modi\",
\"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": "modi",
"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' => 'modi',
'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": 120,
"server_id": 703,
"name": "Dr. Mariana Mosciski",
"description": "Ut tempora qui assumenda aut nulla.",
"type": "firstboot",
"tag": "et quos",
"tags": [
"et",
"quos"
],
"data": "Consectetur deserunt sequi quia facere 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.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\": [
7
],
\"ssh_keys\": [
15
]
}"
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": [
7
],
"ssh_keys": [
15
]
}
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' => [
7,
],
'ssh_keys' => [
15,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 230,
"device_id": 1452,
"template_id": 292,
"server_id": 704,
"message": "Dignissimos iste qui ut sunt corporis inventore.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-08-14 14:27:55",
"updated_at": "2026-08-14 14:27: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.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": 231,
"device_id": 1453,
"template_id": 293,
"server_id": 707,
"message": "Et necessitatibus hic libero ut dignissimos ut occaecati vitae.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-08-14 14:27:56",
"updated_at": "2026-08-14 14:27: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.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": 232,
"device_id": 1454,
"template_id": 294,
"server_id": 710,
"message": "Aut quis eaque enim sequi quam ut quisquam.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-08-14 14:27:56",
"updated_at": "2026-08-14 14:27: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.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": 713,
"app_id": 1258,
"name": "Dannie Dickens",
"module": "Remote Module",
"configuration": {
"app": 1258,
"rebootmethod": "manual",
"nameserver_1": null,
"nameserver_2": null,
"rescue_template": null,
"reinstall_template": null,
"bootloader": "undionly.kpxe"
},
"enabled": 1
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List provisioning tasks
requires authentication
Returns a paginated list of provisioning tasks.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/admin/os/provisioning/tasks?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/tasks'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/provisioning/tasks';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 233,
"device_id": 1455,
"template_id": 295,
"server_id": 714,
"message": "In dolorem atque ut voluptatem sint architecto.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-08-14 14:27:56",
"updated_at": "2026-08-14 14:27:56"
},
{
"id": 234,
"device_id": 1456,
"template_id": 296,
"server_id": 717,
"message": "Id labore odio distinctio nemo odio.",
"dhcp": 1,
"configuration": [],
"log": "",
"created_at": "2026-08-14 14:27:57",
"updated_at": "2026-08-14 14:27:57"
}
],
"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": 141,
"device_id": 1457,
"server_id": 720,
"template": "Mr. Tyree Goldner",
"status": "",
"log": "",
"created_at": "2026-08-14 14:27:57",
"updated_at": "2026-08-14 14:27:57"
},
{
"id": 142,
"device_id": 1458,
"server_id": 721,
"template": "Freda Strosin",
"status": "",
"log": "",
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27: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/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": 95,
"uuid": "80ee343f-683b-35d5-98db-3d030716178e",
"name": "Preseed quam",
"description": "Ab hic amet dolor eum ut facilis inventore.",
"type": {
"value": "preseed",
"label": "Preseed (Debian/Ubuntu legacy)"
},
"version": "1.1",
"predefined": false,
"official": false,
"installation_template": "preseed_dolores",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
},
{
"id": 96,
"uuid": "4752ac1f-a7ca-3f47-8ffb-390aee1bb706",
"name": "Kickstart incidunt",
"description": "Dolorem esse quo maxime quis tempora.",
"type": {
"value": "kickstart",
"label": "Kickstart (RHEL, Alma, Rocky)"
},
"version": "1.0",
"predefined": true,
"official": true,
"installation_template": "kickstart_velit",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27: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/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": 97,
"uuid": "2f7b625c-3e6d-395f-9896-af7ef206c03d",
"name": "Autoinstall incidunt",
"description": "Recusandae eos sed modi aut.",
"type": {
"value": "autoinstall",
"label": "Autoinstall (Ubuntu cloud-init)"
},
"version": "1.1",
"predefined": false,
"official": false,
"installation_template": "autoinstall_blanditiis",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 98,
"uuid": "56989351-834e-35cc-8811-b6c4a618b198",
"name": "Startnet eius",
"description": "Rerum sequi illum qui dolor.",
"type": {
"value": "startnet",
"label": "Startnet (Windows)"
},
"version": "1.0",
"predefined": true,
"official": true,
"installation_template": "startnet_et",
"settings": [],
"update_available": false,
"latest_version": null,
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 144,
"app_id": 1268,
"name": "Prof. Hilario Hegmann",
"locations": [
{
"id": 4368,
"app_id": null,
"name": "Cronin Ltd",
"address": "13609 Emmerich Corner Apt. 155\nBridiestad, ME 21315-2062",
"city": "Itzelport",
"state": "Kansas",
"description": "Doloremque eum ducimus magni ut. Tenetur dolore fugiat nam voluptatum repellendus. Natus laboriosam enim nostrum ducimus. Voluptatem doloremque ex quia hic voluptas.",
"notes": "Incidunt ipsa impedit qui. Voluptatem eveniet id nesciunt quidem ipsa est maiores. Hic enim excepturi porro qui sint et.",
"emergency": "1",
"phone": "+1.872.366.8526",
"flag": "Germany.png",
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
},
{
"id": 4369,
"app_id": null,
"name": "Schmidt-Boyer",
"address": "870 Hammes Plain\nKihntown, WY 56237-6748",
"city": "North Myron",
"state": "Massachusetts",
"description": "Repellat velit totam accusantium dicta ut. Labore qui ut iure modi incidunt ullam sed. Ut vel aut commodi voluptatibus cum quidem amet maxime.",
"notes": "Cupiditate facilis vitae voluptas. Aut vitae voluptatum explicabo ut nobis eum. Rerum incidunt laborum porro facilis.",
"emergency": "1",
"phone": "325-917-1629",
"flag": "Germany.png",
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
}
],
"configuration": []
},
{
"id": 145,
"app_id": 1269,
"name": "Everardo Russel Jr.",
"locations": [
{
"id": 4370,
"app_id": null,
"name": "Ratke-Gleichner",
"address": "942 Brando Gateway Suite 883\nRobelmouth, MD 22513-4325",
"city": "Ericashire",
"state": "South Carolina",
"description": "Libero sapiente sint impedit repellendus veritatis sunt. In beatae fuga assumenda et. Quis doloremque qui exercitationem dolores tempore ipsum consequatur aut. Aspernatur ut molestias qui sit.",
"notes": "Et placeat consequatur aperiam officia aspernatur ut. Enim illum molestiae recusandae aut ullam perspiciatis unde. Omnis sequi consequatur dolorem corrupti consequatur.",
"emergency": "1",
"phone": "734-231-1988",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
},
{
"id": 4371,
"app_id": null,
"name": "Mayer Ltd",
"address": "6359 Brain Tunnel Apt. 403\nReichertville, AR 53362-5302",
"city": "New Hayley",
"state": "West Virginia",
"description": "Omnis earum est sunt voluptas laborum qui. Voluptatum voluptas et quia in.",
"notes": "Libero perspiciatis et corporis vel laborum numquam. Veritatis quaerat illo sunt voluptatem laudantium neque quia pariatur. Sed modi veritatis delectus.",
"emergency": "1",
"phone": "+1-442-340-8886",
"flag": "UK.png",
"created_at": "2026-08-14 14:27:58",
"updated_at": "2026-08-14 14:27:58"
}
],
"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": 146,
"app_id": 1270,
"name": "Dr. Taylor Wilderman",
"locations": [
{
"id": 4372,
"app_id": null,
"name": "Purdy Inc",
"address": "59645 Winnifred Manors Apt. 070\nCaseyfurt, MI 71100-4360",
"city": "Chanellemouth",
"state": "West Virginia",
"description": "Et omnis debitis ea amet sunt. Possimus aut a aperiam qui aspernatur doloribus possimus. Soluta quia dolor est necessitatibus.",
"notes": "Quia provident ea illo id suscipit vero quia quia. Vero at ut rerum. Quisquam cum aut numquam. Non reprehenderit consequatur nemo dignissimos totam laboriosam.",
"emergency": "1",
"phone": "321.692.4716",
"flag": "Germany.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
},
{
"id": 4373,
"app_id": null,
"name": "Runte Inc",
"address": "17175 Dayna Course Apt. 484\nSouth Nikki, OR 27383",
"city": "New Aletha",
"state": "Kansas",
"description": "Esse deserunt ut consequuntur debitis expedita. Et a qui nostrum non nihil quos. Delectus nobis voluptate ullam dolore architecto et perspiciatis. Molestias deleniti neque voluptate rerum qui unde quisquam.",
"notes": "Qui sed ad iste quia tempora et dolor. Exercitationem unde perspiciatis beatae animi nisi. Velit perferendis provident accusantium est officia iure omnis.",
"emergency": "0",
"phone": "580-630-0959",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
}
],
"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\": [
14
],
\"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": [
14
],
"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' => [
14,
],
'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": 147,
"app_id": 1271,
"name": "Dr. Enid Herman",
"locations": [
{
"id": 4374,
"app_id": null,
"name": "Herman, Barton and Marquardt",
"address": "49798 Kenya Pass Apt. 870\nLubowitzfort, WA 94523",
"city": "Rosalialand",
"state": "Utah",
"description": "Quidem tempore blanditiis esse hic assumenda odio earum. Distinctio ducimus quas ut. Sunt officia minima occaecati quaerat ab molestiae.",
"notes": "Facilis cumque ullam et dolore magni. At distinctio vitae voluptatem hic maiores. Quas perspiciatis eius cupiditate tenetur eos cumque nisi aut. Est exercitationem perferendis aliquam qui illum.",
"emergency": "1",
"phone": "+1 (810) 872-3621",
"flag": "Germany.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
},
{
"id": 4375,
"app_id": null,
"name": "Monahan, Kiehn and Ullrich",
"address": "968 Dickinson Trafficway\nNorth Isac, TN 00343",
"city": "Port Novaberg",
"state": "South Dakota",
"description": "Maiores in temporibus modi optio. Quod eaque dicta sint in sunt deleniti commodi. Quod iure hic neque sed.",
"notes": "Nulla omnis ab et nihil. Velit vel amet corrupti provident soluta. Quis blanditiis aliquid officiis omnis non facilis corrupti perspiciatis. Voluptatum rerum doloremque sed ducimus aliquid dolorum.",
"emergency": "0",
"phone": "1-838-908-2698",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
}
],
"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\": [
17
],
\"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": [
17
],
"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' => [
17,
],
'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": 148,
"app_id": 1272,
"name": "Prof. Edmond Boehm",
"locations": [
{
"id": 4376,
"app_id": null,
"name": "Herzog-Runolfsdottir",
"address": "860 Kiley Ridges Apt. 883\nPort Barbarashire, VT 14872-8782",
"city": "Traceton",
"state": "Alabama",
"description": "Corrupti aut nisi molestiae quasi. Ad excepturi non praesentium soluta. Quia deserunt dolores qui at sed aut. Molestias rerum facilis sit laborum architecto ea.",
"notes": "Placeat odio aliquid et tempora qui. Totam et minus impedit omnis optio et. Dolorem voluptatibus quasi enim vel. Quibusdam autem expedita optio.",
"emergency": "0",
"phone": "1-248-892-0785",
"flag": "USA.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
},
{
"id": 4377,
"app_id": null,
"name": "Champlin, Marquardt and Botsford",
"address": "99867 Rusty Loaf\nBradyport, NJ 05342",
"city": "Abshireland",
"state": "New Hampshire",
"description": "In ex enim sapiente in est voluptatem quod. Qui consequuntur voluptatem occaecati quo dolorem optio facere fuga. Culpa et ut assumenda reprehenderit error.",
"notes": "Est nihil aliquid rem est eos exercitationem repellendus harum. Impedit eum eveniet fuga et libero voluptatum. Expedita et saepe voluptatem eius velit.",
"emergency": "0",
"phone": "423.279.6353",
"flag": "Germany.png",
"created_at": "2026-08-14 14:27:59",
"updated_at": "2026-08-14 14:27:59"
}
],
"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": 156,
"device_id": 1460,
"ipmi_proxy_id": 149,
"url": "https://192.168.203.150/client/console/46359/dtTloTPE/ffcdc462c8c5f61b0ae8dd23d5365922c7a56e34",
"status": 1,
"message": "Amet quod molestiae ad inventore adipisci voluptas quo.",
"log": null
},
{
"id": 157,
"device_id": 1461,
"ipmi_proxy_id": 150,
"url": "https://192.168.203.150/client/console/21292/USl0W7HJ/c25e87cf06fd03e39c000709f5291cf284595c10",
"status": 1,
"message": "A aut laborum sint quia ipsum aspernatur harum vitae.",
"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": 158,
"device_id": 1462,
"ipmi_proxy_id": 151,
"url": "https://192.168.203.150/client/console/58266/3AFanbl3/cdd0e569a1228cdeda8fd47639d4824af1ad5c4e",
"status": 1,
"message": "Vitae est voluptatem accusantium totam recusandae sed.",
"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": 159,
"device_id": 1463,
"ipmi_proxy_id": 152,
"url": "https://192.168.203.150/client/console/6932/BCC2iBfC/cfc41a0060553a41165f39e5f8720c2bb4a62e34",
"status": 1,
"message": "Eum qui similique suscipit debitis mollitia officiis.",
"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": 174,
"pool": "235.78.97.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Quod velit quam deleniti et distinctio voluptatem aut maiores.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
},
{
"id": 175,
"pool": "77.166.248.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Qui qui qui eum quo.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
}
],
"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": 176,
"pool": "76.26.1.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Perferendis officia dolores consequatur fugiat eaque impedit.",
"assignment": false,
"excluded_ranges": [],
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "76.26.1.1",
"end": "76.26.1.254"
}
]
},
"addressing": {
"network_address": "76.26.1.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "76.26.1.255",
"first_available_ip": "76.26.1.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28: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.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\"
],
\"excluded_ranges\": [
\"192.168.1.10-192.168.1.20\"
]
}"
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"
],
"excluded_ranges": [
"192.168.1.10-192.168.1.20"
]
}
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',
],
'excluded_ranges' => [
'192.168.1.10-192.168.1.20',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 177,
"pool": "247.254.42.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Et placeat ut saepe cum id.",
"assignment": false,
"excluded_ranges": [],
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "247.254.42.1",
"end": "247.254.42.254"
}
]
},
"addressing": {
"network_address": "247.254.42.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "247.254.42.255",
"first_available_ip": "247.254.42.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28: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.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\"
],
\"excluded_ranges\": [
\"192.168.1.10-192.168.1.20\"
]
}"
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"
],
"excluded_ranges": [
"192.168.1.10-192.168.1.20"
]
}
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',
],
'excluded_ranges' => [
'192.168.1.10-192.168.1.20',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 178,
"pool": "4.110.104.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Sint necessitatibus illum voluptas et qui et.",
"assignment": false,
"excluded_ranges": [],
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "4.110.104.1",
"end": "4.110.104.254"
}
]
},
"addressing": {
"network_address": "4.110.104.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "4.110.104.255",
"first_available_ip": "4.110.104.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28: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.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": 179,
"pool": "60.103.146.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Molestias reprehenderit ut rerum ex voluptatum molestiae.",
"assignment": false,
"excluded_ranges": [],
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"ip_addresses": {
"assigned_ips": [],
"available_ranges": [
{
"start": "60.103.146.1",
"end": "60.103.146.254"
}
]
},
"addressing": {
"network_address": "60.103.146.0",
"network_mask": "255.255.255.0",
"wildcard_mask": "0.0.0.255",
"broadcast_address": "60.103.146.255",
"first_available_ip": "60.103.146.1",
"utilization_percentage": 0,
"available_ips": 254,
"assigned_ips": 0,
"free_ips": 254
},
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28: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.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": 180,
"pool": "107.135.40.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Debitis similique quis laudantium dolorum sequi quo officia.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
},
{
"id": 181,
"pool": "198.71.207.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Facilis id iste asperiores sit sunt sed.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
}
],
"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": 182,
"pool": "40.174.223.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Eos accusantium vel accusamus beatae at accusantium.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
},
{
"id": 183,
"pool": "6.233.76.0",
"mask": 24,
"type": "ipv4",
"status": "available",
"ns1": null,
"ns2": null,
"gateway": null,
"is_master_pool": 0,
"description": "Facere dignissimos nemo eveniet quasi eaque et.",
"assignment": false,
"tenants": [],
"children": [],
"parent": null,
"vlan": null,
"created_at": "2026-08-14 14:28:01",
"updated_at": "2026-08-14 14:28:01"
}
],
"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": 1464,
"label": "pariatur",
"model": "aperiam",
"product_id": 0,
"model_id": 2173,
"parent_id": 0,
"type_id": 2722,
"user_id": 7980,
"order_id": 845,
"location_id": 4403,
"rack_id": 855,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Keebler-Kirlin",
"description": "Mollitia ut repudiandae est sed saepe mollitia.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN561AV",
"serialnumber2": null,
"service_tag": "ST197SE",
"location": "Kreiger Group",
"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": 1465,
"label": "eos",
"model": "sint",
"product_id": 0,
"model_id": 2174,
"parent_id": 0,
"type_id": 2724,
"user_id": 7987,
"order_id": 846,
"location_id": 4407,
"rack_id": 856,
"blade_id": 0,
"os_installation": 0,
"colocation_id": 0,
"provisioning_id": 0,
"manufacturer": "Wisoky-Doyle",
"description": "Ipsam ut sapiente praesentium sed voluptatibus.",
"comments": null,
"status": "available",
"device_status": "running",
"service_status": "activated",
"function": null,
"serialnumber1": "SN801VD",
"serialnumber2": null,
"service_tag": "ST227ZQ",
"location": "Ebert-Marquardt",
"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,
"device_label": "#38 web-prod-01 (PowerEdge R640)",
"value": "200.94.209.231",
"description": "",
"type": "primary",
"ip_type": "ipv4",
"gateway": "200.94.209.1",
"mask": 24,
"subnet_mask": "255.255.255.0",
"cidr": "200.94.209.0/24",
"subnet": {
"id": 12,
"pool": "200.94.209.0",
"mask": 24,
"gateway": "200.94.209.1",
"subnet_mask": "255.255.255.0",
"cidr": "200.94.209.0/24"
},
"vlan": {
"id": 7,
"name": "Production",
"vlan_id": 100
}
},
{
"id": 307,
"item_id": 44,
"value": "146.224.170.224",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 314,
"item_id": 45,
"value": "139.235.236.138",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 328,
"item_id": 47,
"value": "207.243.68.21",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 335,
"item_id": 48,
"value": "46.236.68.242",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 342,
"item_id": 49,
"value": "166.73.24.58",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 356,
"item_id": 51,
"value": "160.24.83.37",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 363,
"item_id": 52,
"value": "80.24.122.22",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 370,
"item_id": 53,
"value": "174.251.45.79",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 377,
"item_id": 54,
"value": "155.150.252.1",
"description": "",
"type": "primary",
"ip_type": "ipv4"
}
],
"links": {
"first": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
"last": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
"prev": null,
"next": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 16,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2",
"label": "2",
"page": 2,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=3",
"label": "3",
"page": 3,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=4",
"label": "4",
"page": 4,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=5",
"label": "5",
"page": 5,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=6",
"label": "6",
"page": 6,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=7",
"label": "7",
"page": 7,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=8",
"label": "8",
"page": 8,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=9",
"label": "9",
"page": 9,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=10",
"label": "10",
"page": 10,
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=15",
"label": "15",
"page": 15,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
"label": "16",
"page": 16,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2",
"label": "Next »",
"page": 2,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/ipam/ips",
"per_page": 10,
"to": 10,
"total": 151,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 91,
"device_id": null,
"vlan_vlan": 2747,
"vlan_name": "in et",
"description": "Temporibus aliquam omnis et tempora et est occaecati.",
"vlan_type": "standard",
"vlan_status": "depreciated",
"device": null
},
{
"id": 92,
"device_id": null,
"vlan_vlan": 3991,
"vlan_name": "odio dolor",
"description": "Dolorem veniam dolor voluptate quia.",
"vlan_type": "provisioning",
"vlan_status": "active",
"device": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/vlans?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/ipam/vlans",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer 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": 93,
"device_id": null,
"vlan_vlan": 2763,
"vlan_name": "quia est",
"description": "Voluptatem eligendi omnis facere harum atque ut.",
"vlan_type": "provisioning",
"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": 94,
"device_id": null,
"vlan_vlan": 917,
"vlan_name": "qui ratione",
"description": "Assumenda temporibus eligendi eaque amet blanditiis voluptatem.",
"vlan_type": "standard",
"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": 95,
"device_id": null,
"vlan_vlan": 512,
"vlan_name": "rerum corrupti",
"description": "Aut vel dignissimos maiores voluptatem aut sequi.",
"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.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\": 60,
\"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": 60,
"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' => 60,
'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.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": 87,
"device_id": 1468,
"user_id": 8016,
"server_id": 129,
"ip": "204.55.125.159",
"from": "larkin.com",
"name": "kshlerin.com",
"ttl": "3600",
"created_at": "2026-08-14 14:28:04",
"updated_at": "2026-08-14 14:28:04"
},
{
"id": 88,
"device_id": 1469,
"user_id": 8024,
"server_id": 130,
"ip": "45.99.148.55",
"from": "leuschke.com",
"name": "botsford.info",
"ttl": "3600",
"created_at": "2026-08-14 14:28:04",
"updated_at": "2026-08-14 14:28: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/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": 89,
"device_id": 1470,
"user_id": 8032,
"server_id": 131,
"ip": "131.114.5.5",
"from": "wiza.biz",
"name": "howell.info",
"ttl": "3600",
"created_at": "2026-08-14 14:28:04",
"updated_at": "2026-08-14 14:28: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 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": 90,
"device_id": 1471,
"user_id": 8040,
"server_id": 132,
"ip": "158.232.2.89",
"from": "douglas.com",
"name": "marvin.com",
"ttl": "3600",
"created_at": "2026-08-14 14:28:05",
"updated_at": "2026-08-14 14:28:05"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete 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": 43,
"device_id": 1472,
"server_id": 133,
"ip": "113.141.239.218",
"name": "corkery.com",
"created_at": "2026-08-14 14:28:05",
"updated_at": "2026-08-14 14:28:05"
},
{
"id": 44,
"device_id": 1473,
"server_id": 134,
"ip": "183.203.199.133",
"name": "champlin.biz",
"created_at": "2026-08-14 14:28:06",
"updated_at": "2026-08-14 14:28:06"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/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": 45,
"device_id": 1474,
"server_id": 135,
"ip": "103.163.213.109",
"name": "bruen.com",
"created_at": "2026-08-14 14:28:06",
"updated_at": "2026-08-14 14:28:06"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.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": 7543,
"username": "christophe.reilly",
"firstname": "Sister",
"lastname": "Romaguera",
"name": "Sister Romaguera",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/7f96914b82ee256aa30e4df41af6c622?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/7f96914b82ee256aa30e4df41af6c622?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": 7544,
"username": "freda05",
"firstname": "Meghan",
"lastname": "Russel",
"name": "Meghan Russel",
"email": "[email protected]",
"company": null,
"avatar": "//www.gravatar.com/avatar/f165e6e6cea3a16d90a79f70d5328037?s=30&d=mm&r=g",
"large_avatar": "//www.gravatar.com/avatar/f165e6e6cea3a16d90a79f70d5328037?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": 72,
"name": "consequuntur veritatis",
"ssh_key": "ssh-rsa N2FlNWY1ZGIzY2ZkZTFjYWE5ZDNhODM4OGUwNTEyMGQ4M2UyNzZhYjUyNDg4ODFhMGYyOTZmYTA2M2VkM2NkNg== user@host",
"default": false,
"fingerprint": "48:b7:b0:44:2d:38:11:b7:8c:26:61:f9:f1:34:2a:7a",
"created_at": "2026-08-14 14:23:41"
},
{
"id": 73,
"name": "libero voluptas",
"ssh_key": "ssh-rsa ZWQ5NTdmY2FiNzJmNTJhYjFiMjQzYjUzNzNkM2RiMTdmZWFmZmVlM2I1MjFkYTQyYzRiZGY2N2JhYjAwNmJmOA== user@host",
"default": false,
"fingerprint": "a4:9d:0c:d9:2d:e0:1b:f5:4b:c7:15:10:fb:c8:10:84",
"created_at": "2026-08-14 14:23:41"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/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": 74,
"name": "ut labore",
"ssh_key": "ssh-rsa YmZlZjBjYTQzMmEyYTYwNTIwZmMyY2FiZjNmYjQ3YjIyZmZhZTExOWYzZDVkYjlmY2Y5NjQyOThjMzYwMTNlMw== user@host",
"default": false,
"fingerprint": "be:88:69:b6:cd:5f:4a:b9:68:0b:93:2a:a9:3f:db:d6",
"created_at": "2026-08-14 14:23:41"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 75,
"name": "aut nam",
"ssh_key": "ssh-rsa ZDM3Y2Q5ZTczMTgxOTg0NDc1NmNmMDEyY2MyNDYwMzJjYzgyMmZhZTAxZjZiYjBlNWY4OTZhNzFlOTk1NDEwYw== user@host",
"default": false,
"fingerprint": "9c:0c:20:eb:df:ba:a7:ac:32:0d:95:be:2b:c5:a4:b5",
"created_at": "2026-08-14 14:23:41"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 76,
"name": "sed ut",
"ssh_key": "ssh-rsa YjRjNDhlZDMyMTUzZTdjMmMzMTQyMmZmMjk0OTQ1MmVlYTg0NzAxNjc3NjdjZDAzNjE4MjEwODM3NWViM2M3Mg== user@host",
"default": false,
"fingerprint": "21:c8:e3:56:30:79:ed:8a:c9:06:bb:39:44:c1:e5:a7",
"created_at": "2026-08-14 14:23:41"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 59,
"related_id": 1396,
"related": {
"label": "provident",
"model": "sapiente",
"location": "Wiegand-Zboncak",
"location_flag": "USA.png",
"metadata": []
},
"type": "Server",
"status": "activated",
"created_at": "2026-08-14 14:23:47"
},
{
"id": 60,
"related_id": 1397,
"related": {
"label": "aut",
"model": "doloremque",
"location": "Rogahn, Bernhard and Skiles",
"location_flag": "Canada.png",
"metadata": []
},
"type": "Colocation",
"status": "",
"created_at": "2026-08-14 14:23: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?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": 61,
"related_id": 1398,
"type": "Server",
"status": "activated",
"created_at": "2026-08-14 14:24:00",
"related": {
"label": "adipisci",
"model": "ipsum",
"location": "Hermann-Jacobs",
"location_flag": "UK.png",
"rack": "Unknown",
"device_status": "running",
"os_installation": 0,
"uptime": {
"is_down": false,
"value": "Unknown"
},
"image": null,
"ip_addresses": [],
"metadata": [],
"metadataGroups": []
},
"access_level": {
"id": 79,
"name": "quia",
"type": "Server",
"default": false,
"value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"position\";i:1;s:5:\"label\";i:2;s:5:\"model\";i:3;s:11:\"description\";i:4;s:8:\"location\";}s:18:\"traffic_statistics\";a:5:{i:0;s:20:\"widget_network_ports\";i:1;s:23:\"widget_last_month_graph\";i:2;s:17:\"left_sidebar_link\";i:3;s:17:\"widget_last_month\";i:4;s:9:\"filtering\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:20:\"widget_average_usage\";i:2;s:17:\"left_sidebar_link\";i:3;s:23:\"widget_last_month_graph\";i:4;s:7:\"outlets\";i:5;s:9:\"filtering\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"update_rdns\";i:1;s:11:\"create_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": 1399,
"label": "minima",
"type": "ut"
},
{
"id": 1400,
"label": "et",
"type": "est"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/client/services/{id}/parts?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/client/services/{id}/parts",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 487,
"port_number": 22,
"port_label": "recusandae",
"user_label": "doloremque",
"outlet_state": "Outlet On",
"connected_item": null,
"connected_port": null,
"power_usage": 34,
"power_usage_units": "Amps",
"power_usage_value": 34,
"power_usage_unit": "amps",
"power_usage_label": "34 Amps"
},
{
"id": 488,
"port_number": 26,
"port_label": "quae",
"user_label": "sed",
"outlet_state": "Outlet Off",
"connected_item": null,
"connected_port": null,
"power_usage": 15,
"power_usage_units": "Amps",
"power_usage_value": 15,
"power_usage_unit": "amps",
"power_usage_label": "15 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": 489,
"port_number": 33,
"port_label": "et",
"user_label": "saepe",
"outlet_state": "Outlet Off",
"connected_item": null,
"connected_port": null,
"power_usage": 37,
"power_usage_units": "Amps",
"power_usage_value": 37,
"power_usage_unit": "amps",
"power_usage_label": "37 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": 7730,
"name": null,
"port_number": 16,
"port_label": "velit",
"user_label": "harum",
"description": "Eaque molestiae id ut.",
"if_type": "propBWAp2Mp",
"adminstate": "down",
"opstate": "down",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "1 kbps"
},
{
"id": 7731,
"name": null,
"port_number": 41,
"port_label": "qui",
"user_label": "commodi",
"description": "Nisi nam repellendus possimus et.",
"if_type": "l3ipvlan",
"adminstate": "up",
"opstate": "up",
"connected_item": null,
"connected_port": null,
"connection": "Unknown",
"speed": "1 kbps"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/client/services/{id}/ports?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/client/services/{id}/ports",
"per_page": 10,
"to": 1,
"total": 2,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "Missing bearer token.|Invalid bearer token|Token not provided."
}
Example response (403, Forbidden):
{
"success": false,
"status": "error",
"message": "Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users."
}
Example response (404, Not Found):
{
"success": false,
"status": "error",
"message": "Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Sensors
List Sensors
requires authentication
Returns a paginated list of sensors associated with the service.
Example request:
curl --request GET \
--get "https://your-easydcim.com/api/v3/client/services/1/sensors?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"import requests
import json
url = 'https://your-easydcim.com/api/v3/client/services/1/sensors'
params = {
'per_page': '10',
'page': '1',
'sort_by': 'id',
'sort_dir': 'asc',
'search_term': 'active,pending',
'search_op': 'like',
'search_fields': 'id',
}
headers = {
'Authorization': 'Bearer {YOUR_AUTH_KEY}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/1/sensors';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'per_page' => '10',
'page' => '1',
'sort_by' => 'id',
'sort_dir' => 'asc',
'search_term' => 'active,pending',
'search_op' => 'like',
'search_fields' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": [
{
"id": 883,
"item_id": 1406,
"name": "et",
"class": "Fans",
"type": "Thermal",
"unit": "Watts",
"index": "Thermal",
"reading": 916,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:24:35",
"updated_at": "2026-08-14 14:24:35"
},
{
"id": 884,
"item_id": 1407,
"name": "ratione",
"class": "Fans",
"type": "Thermal",
"unit": "Volts",
"index": "Thermal",
"reading": 466,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:24:38",
"updated_at": "2026-08-14 14:24:38"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/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": 885,
"item_id": 1408,
"name": "ex",
"class": "Fans",
"type": "Thermal",
"unit": "Voltages",
"index": "Thermal",
"reading": 728,
"last_polled": "0000-00-00 00:00:00",
"configuration": [],
"created_at": "2026-08-14 14:24:41",
"updated_at": "2026-08-14 14:24:41"
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 128,
"name": "possimus-iso",
"iso_url": "https://dach.com/quam-eaque-est-possimus-in-eius-dolores-et-aut.html",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27:53"
},
{
"id": 129,
"name": "dolorem-iso",
"iso_url": "http://gottlieb.net/at-at-voluptatem-rem-magni-vel-labore.html",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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/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": 130,
"name": "distinctio-iso",
"iso_url": "http://www.erdman.com/",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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.|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": 131,
"name": "fugit-iso",
"iso_url": "http://konopelski.net/qui-qui-rerum-ratione",
"status": 1,
"download": {
"status": "waiting",
"message": "Waiting for ISO image download to start..."
},
"created_at": "2026-08-14 14:27:53",
"updated_at": "2026-08-14 14:27: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.|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": 282,
"template_id": 282,
"name": "quasi",
"tags": [
"nemo",
"corrupti",
"vel"
],
"architecture": "x86",
"cache_folder": "id",
"mirror": "http://satterfield.org/porro-a-doloremque-molestiae.html",
"edition": "culpa",
"iso_url": "http://www.senger.com/assumenda-id-odio-est-vel-rem-vel",
"tftp_url": "http://stark.com/",
"license": "doloremque",
"gpxe": "Voluptatem voluptas reiciendis exercitationem quis delectus.",
"disk_layout": "Laudantium tenetur optio velit eum.",
"packages": "Qui quae quam illum.",
"post_installation": "Neque harum est est eius aut explicabo molestiae aliquid.",
"first_boot": "Qui et ipsam quas qui est aut.",
"extras": "Ad labore reprehenderit magni repellat alias.",
"timezone": "Europe/Paris",
"language": "ks",
"family": "",
"is_windows": false,
"is_rescue": false
},
{
"id": 283,
"template_id": 283,
"name": "qui",
"tags": [
"et",
"ad",
"tenetur",
"et",
"in"
],
"architecture": "x86",
"cache_folder": "enim",
"mirror": "http://www.huels.com/",
"edition": "officiis",
"iso_url": "http://littel.com/",
"tftp_url": "http://metz.com/",
"license": "eius",
"gpxe": "Cum qui minima expedita ipsum.",
"disk_layout": "Dolorem qui tempora debitis molestiae repellat incidunt qui.",
"packages": "Nobis assumenda aut debitis sunt.",
"post_installation": "Impedit omnis quam quaerat qui eaque labore temporibus.",
"first_boot": "Rerum est vel nulla assumenda eos cumque.",
"extras": "Voluptatem vel facere dolore odit.",
"timezone": "Asia/Chita",
"language": "iu",
"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": 114,
"name": "Christine Corwin",
"description": "Voluptas quis et est quia.",
"type": "postinstall",
"tag": "perferendis doloremque",
"tags": [
"perferendis",
"doloremque"
],
"data": "Quo veritatis consequatur ipsam nostrum."
},
{
"id": 115,
"name": "Audie Schinner",
"description": "Et nihil aut perferendis incidunt totam corporis.",
"type": "postinstall",
"tag": "dolore voluptas",
"tags": [
"dolore",
"voluptas"
],
"data": "Quo aut recusandae voluptatem molestiae."
}
],
"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\": [
18
]
}"
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": [
18
]
}
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' => [
18,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"success": true,
"status": "success",
"message": "success",
"data": {
"id": 227,
"device_id": 1449,
"template_id": 284,
"message": "Est qui rem ut unde.",
"log": "",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27: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.|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": 228,
"device_id": 1450,
"template_id": 285,
"message": "Alias minima alias ex.",
"log": "",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27: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.|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": 229,
"device_id": 1451,
"template_id": 286,
"message": "Quo unde facere quisquam hic error.",
"log": "",
"created_at": "2026-08-14 14:27:54",
"updated_at": "2026-08-14 14:27: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.|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": 155,
"device_id": 1459,
"url": "https://192.168.203.150/client/console/40142/IqtErPWV/312c991bbdbcb60d39acc5ee9d97da1605703266",
"status": 1,
"message": "Ut qui enim minima aut dolores."
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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,
"device_label": "#38 web-prod-01 (PowerEdge R640)",
"value": "200.94.209.231",
"description": "",
"type": "primary",
"ip_type": "ipv4",
"gateway": "200.94.209.1",
"mask": 24,
"subnet_mask": "255.255.255.0",
"cidr": "200.94.209.0/24",
"subnet": {
"id": 12,
"pool": "200.94.209.0",
"mask": 24,
"gateway": "200.94.209.1",
"subnet_mask": "255.255.255.0",
"cidr": "200.94.209.0/24"
},
"vlan": {
"id": 7,
"name": "Production",
"vlan_id": 100
}
},
{
"id": 307,
"item_id": 44,
"value": "146.224.170.224",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 314,
"item_id": 45,
"value": "139.235.236.138",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 328,
"item_id": 47,
"value": "207.243.68.21",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 335,
"item_id": 48,
"value": "46.236.68.242",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 342,
"item_id": 49,
"value": "166.73.24.58",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 356,
"item_id": 51,
"value": "160.24.83.37",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 363,
"item_id": 52,
"value": "80.24.122.22",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 370,
"item_id": 53,
"value": "174.251.45.79",
"description": "",
"type": "primary",
"ip_type": "ipv4"
},
{
"id": 377,
"item_id": 54,
"value": "155.150.252.1",
"description": "",
"type": "primary",
"ip_type": "ipv4"
}
],
"links": {
"first": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
"last": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
"prev": null,
"next": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 16,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2",
"label": "2",
"page": 2,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=3",
"label": "3",
"page": 3,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=4",
"label": "4",
"page": 4,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=5",
"label": "5",
"page": 5,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=6",
"label": "6",
"page": 6,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=7",
"label": "7",
"page": 7,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=8",
"label": "8",
"page": 8,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=9",
"label": "9",
"page": 9,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=10",
"label": "10",
"page": 10,
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=15",
"label": "15",
"page": 15,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
"label": "16",
"page": 16,
"active": false
},
{
"url": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2",
"label": "Next »",
"page": 2,
"active": false
}
],
"path": "https://your-easydcim.com/api/v3/admin/ipam/ips",
"per_page": 10,
"to": 10,
"total": 151,
"sort_by": "",
"sort_dir": null
}
}
Example response (401, Unauthorized):
{
"success": false,
"status": "error",
"message": "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": 172,
"subnet": "11.72.20.0/24",
"pool": "11.72.20.0",
"mask": 24,
"gateway": null,
"type": "ipv4"
},
{
"id": 173,
"subnet": "101.240.225.0/24",
"pool": "101.240.225.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": 85,
"device_id": 1466,
"user_id": 8000,
"server_id": 127,
"ip": "252.113.74.165",
"from": "collier.com",
"name": "feest.com",
"ttl": "3600",
"created_at": "2026-08-14 14:28:03",
"updated_at": "2026-08-14 14:28:03"
},
{
"id": 86,
"device_id": 1467,
"user_id": 8008,
"server_id": 128,
"ip": "172.46.54.88",
"from": "shanahan.com",
"name": "lebsack.biz",
"ttl": "3600",
"created_at": "2026-08-14 14:28:03",
"updated_at": "2026-08-14 14:28:03"
}
],
"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.