MENU navbar-image

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": ""
        },
        "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"
        }
    }
}

Request   

GET api/v3/admin/client-area/config

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

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\",
    \"version\": \"2.0.0\",
    \"is_enabled\": false,
    \"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\');\"
    }
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/client-area/config'
payload = {
    "mode": "external",
    "full_url": "https:\/\/client.example.com",
    "version": "2.0.0",
    "is_enabled": false,
    "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');"
    }
}
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',
            'version' => '2.0.0',
            'is_enabled' => false,
            '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\');',
            ],
        ],
    ]
);
$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."
}

Request   

POST api/v3/admin/client-area/config

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

mode   string  optional    

Client Area mode. Either "local" (embedded) or "external" (remote URL). Example: external

Must be one of:
  • local
  • external
full_url   string  optional    

The full URL of the external Client Area (used only in external mode). Must be a valid URL. Example: https://client.example.com

version   string  optional    

Client Area version. Example: 2.0.0

is_enabled   boolean  optional    

Boolean flag indicating whether the Client Area is enabled. Example: false

branding   object  optional    

Branding settings for the Client Area. Only Base64-encoded images are allowed for logos and favicon.
colors_primary   string[]  optional    

Must match the regex /^#[0-9A-Fa-f]{6}$/.

logo_url   string  optional    

Example: data:image/svg+xml;base64,PHN2ZyB3aWR0aD0i...

logo_dark_url   string  optional    

Example: data:image/svg+xml;base64,PHN2ZyB3aWR0aD0i...

favicon_url   string  optional    

Example: data:image/png;base64,iVBORw0K...

custom_css   string  optional    

Example: body { background: #f4f4f4; }

custom_js_header   string  optional    

Example: console.log('Header loaded');

custom_js_footer   string  optional    

Example: console.log('Footer loaded');

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."
}

Request   

GET api/v3/admin/system/config

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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."
}

Request   

GET api/v3/admin/system/health-check

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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": 5406,
            "app_id": null,
            "name": "Volkman and Sons",
            "address": "4324 Vallie Street Apt. 154\nWest Blaze, UT 65201-5568",
            "city": "Lake Cassandrahaven",
            "state": "Delaware",
            "description": "Similique et sit molestiae tempora officiis distinctio illo. Voluptatibus suscipit pariatur rerum impedit harum ut. Optio non ea ut maiores. Autem voluptatum quis quas et repudiandae quia ea.",
            "notes": "Sit delectus illum dignissimos consequatur. Quia aliquid ut nesciunt consectetur iste. Velit dolorem amet animi est magnam pariatur iusto. Itaque maxime dolores veniam reiciendis aut magnam.",
            "emergency": "0",
            "phone": "1-484-206-6291",
            "flag": "USA.png",
            "created_at": "2025-11-12 09:09:24",
            "updated_at": "2025-11-12 09:09:24"
        },
        {
            "id": 5407,
            "app_id": null,
            "name": "Reynolds, Zemlak and Shanahan",
            "address": "66263 Labadie Terrace Apt. 648\nEast Arvillamouth, WI 85525-9848",
            "city": "East Zella",
            "state": "Alaska",
            "description": "Voluptatem voluptas atque excepturi distinctio. Ratione similique eveniet consectetur quasi enim.",
            "notes": "Laboriosam non autem nemo quasi culpa esse quo. Voluptatum quas in voluptatibus harum atque non et eos.",
            "emergency": "0",
            "phone": "478.809.2501",
            "flag": "Canada.png",
            "created_at": "2025-11-12 09:09:24",
            "updated_at": "2025-11-12 09:09:24"
        }
    ],
    "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."
}

Request   

GET api/v3/admin/locations

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, city, state. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, city, state. Example: id

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": 5408,
        "app_id": null,
        "name": "Upton-Hane",
        "address": "41191 Ariel Throughway Suite 780\nAnnaburgh, KY 27977",
        "city": "Lake Enahaven",
        "state": "Washington",
        "description": "Voluptas autem qui sed voluptatem neque ipsa molestiae. Repellat eum doloribus magnam itaque ex. In rem eos distinctio autem dolore in.",
        "notes": "Illo dolores odit et voluptatem animi. A eos fugiat nesciunt nemo quia quisquam. Libero qui perspiciatis eligendi quos et. Quia maxime est qui aut repudiandae totam.",
        "emergency": "0",
        "phone": "(315) 925-2393",
        "flag": "Germany.png",
        "created_at": "2025-11-12 09:09:25",
        "updated_at": "2025-11-12 09:09:25"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/locations/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the location. Example: 1

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": 5409,
        "app_id": null,
        "name": "Bernhard PLC",
        "address": "97093 Mohr Parks\nStoltenbergland, MO 14185-1532",
        "city": "New Sadyemouth",
        "state": "Maryland",
        "description": "Et fugiat vero vitae odio quia quo laboriosam quos. Dolor quo est quidem dolores molestiae aperiam porro sapiente. Assumenda impedit omnis corrupti et dolorem necessitatibus.",
        "notes": "Est omnis quia aut sint est. Ut tempora nobis ut quia. Non eveniet eveniet est blanditiis ut sequi eligendi.",
        "emergency": "0",
        "phone": "1-458-821-6179",
        "flag": "Germany.png",
        "created_at": "2025-11-12 09:09:25",
        "updated_at": "2025-11-12 09:09:25"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/locations

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The unique name of the location. Must not be greater than 255 characters. Example: New York Data Center

address   string  optional    

The physical address of the location. Must not be greater than 500 characters. Example: 1234 Madison Ave, New York, NY

phone   string  optional    

A contact phone number for the location. Must not be greater than 50 characters. Example: +1 212-555-0199

description   string  optional    

Additional details about the location. Must not be greater than 1000 characters. Example: Main East Coast colocation facility.

manager_id   integer  optional    

The ID of the user who manages this location. The id of an existing record in the users table. Example: 42

remote_agent   integer  optional    

The ID of the remote agent linked with this location (optional). Example: 7

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": 5410,
        "app_id": null,
        "name": "Murphy, Oberbrunner and Ratke",
        "address": "2898 Vincent Creek Suite 129\nLake Sigrid, IL 31865",
        "city": "South Marjorieview",
        "state": "Oregon",
        "description": "Maiores hic quam et quo a. Recusandae numquam excepturi error ducimus. Est error earum dicta.",
        "notes": "Iure dolores atque mollitia eum. Veritatis quia corporis consequuntur rerum nobis. Ut qui consequuntur cupiditate commodi quia voluptate.",
        "emergency": "0",
        "phone": "(716) 725-6106",
        "flag": "Germany.png",
        "created_at": "2025-11-12 09:09:25",
        "updated_at": "2025-11-12 09:09:25"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/locations/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the location. Example: 5

Body Parameters

name   string  optional    

The unique name of the location. Must not be greater than 255 characters. Example: Warsaw DC-1

address   string  optional    

The physical address of the location. Must not be greater than 500 characters. Example: ul. Marszałkowska 10, Warsaw, PL

phone   string  optional    

A contact phone number for the location. Must not be greater than 50 characters. Example: +48 22 123 45 67

description   string  optional    

Additional details about the location. Must not be greater than 1000 characters. Example: Primary colocation facility in Warsaw.

manager_id   integer  optional    

The ID of the user who manages this location. The id of an existing record in the users table. Example: 12

remote_agent   integer  optional    

The ID of the remote agent linked with this location (optional). Example: 3

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."
}

Request   

DELETE api/v3/admin/locations/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the location. Example: 7

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": 958,
            "name": "magnam",
            "floor_id": 1049,
            "location_id": 5411,
            "description": "Dignissimos provident fugit molestiae omnis.",
            "room": "esse",
            "units_number": 65,
            "weight": 143,
            "speed": 100,
            "manager_id": 9553,
            "location": {
                "id": 5411,
                "app_id": null,
                "name": "Medhurst Group",
                "address": "7121 Lockman Rapid\nLebsackstad, CO 22359-9997",
                "city": "Lake Oren",
                "state": "Vermont",
                "description": "Reiciendis fugit temporibus consequatur porro id iure. Aut odit reiciendis nisi aut consequatur dolor sunt. Consectetur ut et non facere dolor.",
                "notes": "Fuga eos ut rerum facilis quos. Ducimus officia id est. Magni assumenda cupiditate laudantium atque quam.",
                "emergency": "0",
                "phone": "325.668.4026",
                "flag": "Canada.png",
                "created_at": "2025-11-12 09:09:25",
                "updated_at": "2025-11-12 09:09:25"
            },
            "floor": {
                "id": 1049,
                "name": "quibusdam",
                "number": 33,
                "rows": 3,
                "columns": 9,
                "racks": [
                    {
                        "id": 958,
                        "name": "magnam"
                    }
                ],
                "created_at": "2025-11-12 09:09:26",
                "updated_at": "2025-11-12 09:09:26"
            },
            "manager": {
                "id": 9553,
                "username": "cordia82",
                "email": "[email protected]",
                "name": "Yvonne Kozey",
                "firstname": "Yvonne",
                "lastname": "Kozey",
                "gender": "0",
                "avatar": "//www.gravatar.com/avatar/65a57577b258825c557ac9905d2829cb?s=30&d=mm&r=g",
                "large_avatar": "//www.gravatar.com/avatar/65a57577b258825c557ac9905d2829cb?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": "2025-11-12 09:09:26",
            "updated_at": "2025-11-12 09:09:26"
        },
        {
            "id": 959,
            "name": "inventore",
            "floor_id": 1050,
            "location_id": 5413,
            "description": "Atque incidunt quos laudantium reiciendis commodi.",
            "room": "quis",
            "units_number": 75,
            "weight": 134,
            "speed": 100,
            "manager_id": 9556,
            "location": {
                "id": 5413,
                "app_id": null,
                "name": "Collins, Schroeder and Mayert",
                "address": "864 Koepp Ford\nNorth Alphonso, MO 08129",
                "city": "East Merlinberg",
                "state": "Arkansas",
                "description": "Dignissimos non libero unde ipsa autem quam. Consequatur sed occaecati dolores eligendi eius qui deleniti. Voluptas dolorem ut officia molestiae. Mollitia quisquam deserunt corporis sapiente enim.",
                "notes": "Eaque vel odio eveniet ut placeat sed ab. Beatae repellendus omnis ex et voluptatem. Doloribus est et tempore animi qui nulla. Officiis facilis suscipit et.",
                "emergency": "1",
                "phone": "+19568622914",
                "flag": "UK.png",
                "created_at": "2025-11-12 09:09:26",
                "updated_at": "2025-11-12 09:09:26"
            },
            "floor": {
                "id": 1050,
                "name": "nemo",
                "number": 45,
                "rows": 6,
                "columns": 8,
                "racks": [
                    {
                        "id": 959,
                        "name": "inventore"
                    }
                ],
                "created_at": "2025-11-12 09:09:26",
                "updated_at": "2025-11-12 09:09:26"
            },
            "manager": {
                "id": 9556,
                "username": "roger82",
                "email": "[email protected]",
                "name": "Gene Shanahan",
                "firstname": "Gene",
                "lastname": "Shanahan",
                "gender": "0",
                "avatar": "//www.gravatar.com/avatar/82b54565bc56fb5b3979f9dfc049ff92?s=30&d=mm&r=g",
                "large_avatar": "//www.gravatar.com/avatar/82b54565bc56fb5b3979f9dfc049ff92?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": "2025-11-12 09:09:27",
            "updated_at": "2025-11-12 09:09: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/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."
}

Request   

GET api/v3/admin/racks

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, location_id, floor_id, units_number, weight, manager_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, location_id, floor_id. Example: id

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": 960,
        "name": "aut",
        "floor_id": 1051,
        "location_id": 5415,
        "description": "Placeat est vel eligendi consectetur est modi.",
        "room": "non",
        "units_number": 74,
        "weight": 148,
        "speed": 1000,
        "manager_id": 9559,
        "location": {
            "id": 5415,
            "app_id": null,
            "name": "Swift and Sons",
            "address": "3982 Lelia Parkway\nNorth Ryleechester, MA 37921",
            "city": "Georgetteview",
            "state": "South Carolina",
            "description": "Earum quia eos amet quam voluptatem dolorem perferendis ut. Dolores quaerat ut hic velit eaque.",
            "notes": "Aut consequatur tenetur et tenetur. Excepturi asperiores expedita iure est et. Sit aut nam et. Modi ut nihil est iste dolorum beatae iure.",
            "emergency": "0",
            "phone": "1-716-977-5545",
            "flag": "USA.png",
            "created_at": "2025-11-12 09:09:27",
            "updated_at": "2025-11-12 09:09:27"
        },
        "floor": {
            "id": 1051,
            "name": "et",
            "number": 16,
            "rows": 3,
            "columns": 7,
            "racks": [
                {
                    "id": 960,
                    "name": "aut"
                }
            ],
            "created_at": "2025-11-12 09:09:27",
            "updated_at": "2025-11-12 09:09:27"
        },
        "manager": {
            "id": 9559,
            "username": "ttremblay",
            "email": "[email protected]",
            "name": "Flo Leannon",
            "firstname": "Flo",
            "lastname": "Leannon",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/2d98ef46b6b118938d7b9ae6efc245df?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/2d98ef46b6b118938d7b9ae6efc245df?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": "2025-11-12 09:09:27",
        "updated_at": "2025-11-12 09:09:27"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/racks/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

Rack ID. Example: 5

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": 961,
        "name": "quasi",
        "floor_id": 1052,
        "location_id": 5417,
        "description": "Ducimus sint fugiat architecto harum.",
        "room": "quas",
        "units_number": 63,
        "weight": 86,
        "speed": 1000,
        "manager_id": 9562,
        "location": {
            "id": 5417,
            "app_id": null,
            "name": "Connelly-Conn",
            "address": "629 Blick Key Suite 575\nPort Zoeymouth, VT 66329-4356",
            "city": "Port Bentontown",
            "state": "Montana",
            "description": "Magni sunt deserunt optio fugiat omnis nulla. Numquam recusandae unde hic deserunt eveniet sit. Magni laudantium quia tempora sunt molestiae. Distinctio ut vero mollitia laudantium.",
            "notes": "Vero consequatur voluptatem enim accusantium libero. Dolores repellendus ipsam aut adipisci. Ex accusantium quis laborum similique et accusantium. Natus ab sed quae quae.",
            "emergency": "1",
            "phone": "+16282399793",
            "flag": "USA.png",
            "created_at": "2025-11-12 09:09:27",
            "updated_at": "2025-11-12 09:09:27"
        },
        "floor": {
            "id": 1052,
            "name": "ipsum",
            "number": 8,
            "rows": 4,
            "columns": 3,
            "racks": [
                {
                    "id": 961,
                    "name": "quasi"
                }
            ],
            "created_at": "2025-11-12 09:09:28",
            "updated_at": "2025-11-12 09:09:28"
        },
        "manager": {
            "id": 9562,
            "username": "pcormier",
            "email": "[email protected]",
            "name": "Charity Lesch",
            "firstname": "Charity",
            "lastname": "Lesch",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/c80a6d0201d8e2e249b10251721bb69f?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/c80a6d0201d8e2e249b10251721bb69f?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": "2025-11-12 09:09:28",
        "updated_at": "2025-11-12 09:09:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/racks

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The unique name of the rack. Must not be greater than 255 characters. Example: Rack A-101

location_id   integer     

The ID of the location where this rack is placed. The id of an existing record in the locations table. Example: 5

floor_id   integer     

The ID of the floor where this rack is located. The id of an existing record in the floors table. Example: 12

description   string  optional    

Additional details about the rack. Must not be greater than 1000 characters. Example: 42U rack with redundant power.

room   string  optional    

Optional room identifier within the floor. Must not be greater than 255 characters. Example: Server Room 2B

units_number   integer  optional    

Total number of units (U) available in the rack. Must be at least 0. Must not be greater than 120. Example: 42

weight   number  optional    

Maximum supported weight of devices in kg. Must be at least 0. Example: 350

manager_id   integer  optional    

The ID of the user who manages this rack. The id of an existing record in the users table. Example: 42

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": 962,
        "name": "nobis",
        "floor_id": 1053,
        "location_id": 5419,
        "description": "Corporis hic ipsa est aliquid sint.",
        "room": "sunt",
        "units_number": 34,
        "weight": 180,
        "speed": 10,
        "manager_id": 9565,
        "location": {
            "id": 5419,
            "app_id": null,
            "name": "Rempel-Witting",
            "address": "969 Schmeler Stream Apt. 375\nSouth Julietmouth, RI 52126",
            "city": "West Alexane",
            "state": "Arizona",
            "description": "Possimus sint optio assumenda placeat aut quae accusamus. Inventore eum quos laborum eius.",
            "notes": "Tempora ad est debitis et perspiciatis. In accusamus non numquam veniam neque est. Voluptatem reiciendis occaecati soluta sunt dolor quisquam dolorem.",
            "emergency": "0",
            "phone": "+1 (661) 208-1366",
            "flag": "Canada.png",
            "created_at": "2025-11-12 09:09:28",
            "updated_at": "2025-11-12 09:09:28"
        },
        "floor": {
            "id": 1053,
            "name": "hic",
            "number": 79,
            "rows": 1,
            "columns": 8,
            "racks": [
                {
                    "id": 962,
                    "name": "nobis"
                }
            ],
            "created_at": "2025-11-12 09:09:28",
            "updated_at": "2025-11-12 09:09:28"
        },
        "manager": {
            "id": 9565,
            "username": "doyle.winifred",
            "email": "[email protected]",
            "name": "Haleigh Wintheiser",
            "firstname": "Haleigh",
            "lastname": "Wintheiser",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/b3265b767168c722035cfe3b4f39dc0f?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/b3265b767168c722035cfe3b4f39dc0f?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": "2025-11-12 09:09:28",
        "updated_at": "2025-11-12 09:09:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/racks/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

Rack ID. Example: 5

Body Parameters

name   string  optional    

The unique name of the rack. Must not be greater than 255 characters. Example: Rack A-101

location_id   integer  optional    

The ID of the location where this rack is placed. The id of an existing record in the locations table. Example: 5

floor_id   integer  optional    

The ID of the floor where this rack is located. The id of an existing record in the floors table. Example: 12

description   string  optional    

Additional details about the rack. Must not be greater than 1000 characters. Example: 42U rack with redundant power.

room   string  optional    

Optional room identifier within the floor. Must not be greater than 255 characters. Example: Server Room 2B

units_number   integer  optional    

Total number of units (U) available in the rack. Must be at least 0. Must not be greater than 120. Example: 42

weight   number  optional    

Maximum supported weight of devices in kg. Must be at least 0. Example: 350

manager_id   integer  optional    

The ID of the user who manages this rack. The id of an existing record in the users table. Example: 42

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."
}

Request   

DELETE api/v3/admin/racks/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

Rack ID. Example: 5

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": 1054,
            "name": "id",
            "number": 80,
            "rows": 8,
            "columns": 3,
            "racks": [],
            "created_at": "2025-11-12 09:09:29",
            "updated_at": "2025-11-12 09:09:29"
        },
        {
            "id": 1055,
            "name": "sit",
            "number": 95,
            "rows": 9,
            "columns": 5,
            "racks": [],
            "created_at": "2025-11-12 09:09:29",
            "updated_at": "2025-11-12 09:09:29"
        }
    ],
    "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."
}

Request   

GET api/v3/admin/floors

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, number, location_id, rows, columns. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, number, location_id. Example: id

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": 1056,
        "name": "nostrum",
        "number": 72,
        "rows": 10,
        "columns": 6,
        "racks": [],
        "created_at": "2025-11-12 09:09:29",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

GET api/v3/admin/floors/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the floor. Example: 1

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": 1057,
        "name": "facere",
        "number": 33,
        "rows": 8,
        "columns": 1,
        "racks": [],
        "created_at": "2025-11-12 09:09:30",
        "updated_at": "2025-11-12 09:09:30"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/floors

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The unique name of the floor. Must not be greater than 255 characters. Example: Floor 1

number   integer     

The floor number (e.g. 1 for first floor, 2 for second floor). Must be at least 1. Example: 2

rows   integer     

The number of rows in the floor grid. Must be at least 1. Example: 10

columns   integer     

The number of columns in the floor grid. Must be at least 1. Example: 8

location_id   integer     

The ID of the location this floor belongs to. The id of an existing record in the locations table. Example: 1

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": 1058,
        "name": "sit",
        "number": 45,
        "rows": 8,
        "columns": 5,
        "racks": [],
        "created_at": "2025-11-12 09:09:30",
        "updated_at": "2025-11-12 09:09:30"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/floors/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the floor. Example: 3

Body Parameters

name   string  optional    

The unique name of the floor. Must not be greater than 255 characters. Example: Updated Floor 2

number   integer  optional    

The floor number (e.g. 1 for first floor, 2 for second floor). Must be at least 1. Example: 3

rows   integer  optional    

The number of rows in the floor grid. Must be at least 1. Example: 12

columns   integer  optional    

The number of columns in the floor grid. Must be at least 1. Example: 15

location_id   integer  optional    

The ID of the location this floor belongs to. The id of an existing record in the locations table. Example: 2

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."
}

Request   

DELETE api/v3/admin/floors/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the floor. Example: 5

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": 2469,
            "name": "rem",
            "label": "corrupti",
            "type_id": 2986,
            "type": {
                "id": 2986,
                "name": "enim"
            },
            "location_id": 5426,
            "status": "in_use",
            "description": "Reprehenderit sit quia in ipsum eligendi.",
            "is_part": true,
            "mountable": false,
            "manufacturer": "Price, Mohr and Ferry",
            "position": "deleniti",
            "size": 0,
            "image": "https://via.placeholder.com/640x480.png/00aa33?text=veniam",
            "data_ports": 8,
            "serialnumber1": "ce72db9a-8d1a-34f3-991e-b0dd686b2c59",
            "serialnumber2": "7c67b798-eeef-38b4-b4a9-f20a60e5f023",
            "service_tag": "f03700d1-a8f2-3950-ba1b-6bc5fbcfdc32",
            "comments": "Commodi nobis voluptatem aliquam. Consequatur non voluptate vel quos facilis.",
            "notes": "Cum voluptates veniam rerum sint ipsam aut nihil. Ut ut impedit dignissimos ut unde dolorem. Id fuga odio sit aut consequatur. Quo facilis id laudantium amet ut alias deleniti et.",
            "purchase_date": "2002-02-24",
            "warranty_months": 28,
            "warranty_info": "Voluptatum non quia officiis mollitia et.",
            "function": "odio",
            "maintenance_instruction": "Voluptas eaque dolore ipsam autem eos. Ipsa nobis hic dolor tenetur dolorem suscipit. Corporis in vitae aut inventore iusto enim esse unde.",
            "origin": "Nepal",
            "buy_price": 236.76,
            "appdata": "a:1:{s:3:\"key\";s:4:\"modi\";}",
            "fields_data": "a:1:{s:5:\"field\";s:3:\"sed\";}",
            "parts_data": "a:1:{s:4:\"part\";s:3:\"aut\";}",
            "created_at": "2025-11-12T08:09:30.000000Z",
            "updated_at": "2025-11-12T08:09:30.000000Z"
        },
        {
            "id": 2470,
            "name": "sit",
            "label": "neque",
            "type_id": 2987,
            "type": {
                "id": 2987,
                "name": "voluptate"
            },
            "location_id": 5427,
            "status": "available",
            "description": "Quidem debitis sunt corrupti est odit ex.",
            "is_part": true,
            "mountable": false,
            "manufacturer": "Upton-Kassulke",
            "position": "qui",
            "size": 0,
            "image": "https://via.placeholder.com/640x480.png/0088cc?text=harum",
            "data_ports": 6,
            "serialnumber1": "1b6fb7e5-20ed-3144-a48e-f0ee1134a066",
            "serialnumber2": "5ffe8f0d-1e83-3f92-9e41-1df760043c14",
            "service_tag": "5aaa293e-848f-3abb-9ac2-c802c63e97e5",
            "comments": "Tempore quidem ipsa non aut repellendus sunt. Quibusdam voluptatem et sunt repellendus nulla sunt qui. Molestiae maxime id maxime deserunt quia. Sed possimus iure eligendi rerum numquam.",
            "notes": "Voluptas tenetur qui accusamus nesciunt veniam perferendis doloribus. Commodi qui maxime eos maiores. Facilis iusto reiciendis aperiam ratione rerum dolore et quo.",
            "purchase_date": "2009-11-23",
            "warranty_months": 22,
            "warranty_info": "Aut dolore et ipsa consequatur itaque.",
            "function": "voluptatem",
            "maintenance_instruction": "Quaerat possimus provident veniam rerum sit fugiat. Quia amet molestiae et voluptatem culpa. Aut quia quos quidem vero quibusdam voluptatem. Animi explicabo vel consequatur cupiditate officia quo.",
            "origin": "Liechtenstein",
            "buy_price": 759.34,
            "appdata": "a:1:{s:3:\"key\";s:2:\"at\";}",
            "fields_data": "a:1:{s:5:\"field\";s:4:\"quae\";}",
            "parts_data": "a:1:{s:4:\"part\";s:5:\"atque\";}",
            "created_at": "2025-11-12T08:09:31.000000Z",
            "updated_at": "2025-11-12T08:09:31.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."
}

Request   

GET api/v3/admin/item-models

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, label, manufacturer, status, type_id, location_id, created_at. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, label, manufacturer, status. Example: id

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": 2471,
        "name": "et",
        "label": "id",
        "type_id": 2988,
        "type": {
            "id": 2988,
            "name": "neque"
        },
        "location_id": 5428,
        "status": "available",
        "description": "Laudantium hic beatae qui consequatur.",
        "is_part": false,
        "mountable": true,
        "manufacturer": "Okuneva-Renner",
        "position": "minus",
        "size": 0,
        "image": "https://via.placeholder.com/640x480.png/004488?text=illo",
        "data_ports": 10,
        "serialnumber1": "2df269ce-947d-34f3-8b23-75614665ea72",
        "serialnumber2": "7299b53c-d385-3b9d-975a-aec07508fa45",
        "service_tag": "21f6c238-bcdf-316a-869a-857d3ade1587",
        "comments": "Officia dolorum rerum maxime et. Quis quaerat est iusto voluptatem reiciendis voluptatem iste.",
        "notes": "Quia officia itaque vero ducimus sint cum culpa. Eum ratione laudantium provident quia distinctio aut. Quia voluptatibus ad qui iusto incidunt quo.",
        "purchase_date": "1980-08-18",
        "warranty_months": 18,
        "warranty_info": "Aut rem ut minus.",
        "function": "eum",
        "maintenance_instruction": "Repellat non eveniet fugit repudiandae. Vero sit qui debitis necessitatibus at. Unde sed recusandae tempore aut. Voluptate blanditiis provident illo debitis quam eum expedita.",
        "origin": "Cayman Islands",
        "buy_price": 957.17,
        "appdata": "a:1:{s:3:\"key\";s:6:\"minima\";}",
        "fields_data": "a:1:{s:5:\"field\";s:11:\"consequatur\";}",
        "parts_data": "a:1:{s:4:\"part\";s:10:\"voluptatum\";}",
        "created_at": "2025-11-12T08:09:31.000000Z",
        "updated_at": "2025-11-12T08:09:31.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."
}

Request   

GET api/v3/admin/item-models/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item model. Example: 10

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\": \"nuiztwlk\",
    \"serialnumber1\": \"SN123456789\",
    \"serialnumber2\": \"SN987654321\",
    \"service_tag\": \"ST-001122\",
    \"comments\": \"bvpc\",
    \"notes\": \"bkwaoofakw\",
    \"purchase_date\": \"2025-11-12T09:09:31\",
    \"warranty_months\": 36,
    \"warranty_info\": \"gvhahywoengu\",
    \"function\": \"iahmmdxdxyfpxzlfkcsmgwak\",
    \"maintenance_instruction\": \"ggxhtnsyzwsyhnqhkllotgu\",
    \"origin\": \"jojzqxbprszashlewvobpnhww\",
    \"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": "nuiztwlk",
    "serialnumber1": "SN123456789",
    "serialnumber2": "SN987654321",
    "service_tag": "ST-001122",
    "comments": "bvpc",
    "notes": "bkwaoofakw",
    "purchase_date": "2025-11-12T09:09:31",
    "warranty_months": 36,
    "warranty_info": "gvhahywoengu",
    "function": "iahmmdxdxyfpxzlfkcsmgwak",
    "maintenance_instruction": "ggxhtnsyzwsyhnqhkllotgu",
    "origin": "jojzqxbprszashlewvobpnhww",
    "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' => 'nuiztwlk',
            'serialnumber1' => 'SN123456789',
            'serialnumber2' => 'SN987654321',
            'service_tag' => 'ST-001122',
            'comments' => 'bvpc',
            'notes' => 'bkwaoofakw',
            'purchase_date' => '2025-11-12T09:09:31',
            'warranty_months' => 36,
            'warranty_info' => 'gvhahywoengu',
            'function' => 'iahmmdxdxyfpxzlfkcsmgwak',
            'maintenance_instruction' => 'ggxhtnsyzwsyhnqhkllotgu',
            'origin' => 'jojzqxbprszashlewvobpnhww',
            'buy_price' => 2500.0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 2472,
        "name": "quos",
        "label": "at",
        "type_id": 2989,
        "type": {
            "id": 2989,
            "name": "nostrum"
        },
        "location_id": 5429,
        "status": "unavailable",
        "description": "Ipsum aperiam aspernatur culpa quia tempore iusto dolore.",
        "is_part": false,
        "mountable": true,
        "manufacturer": "Crona Inc",
        "position": "rerum",
        "size": 0,
        "image": "https://via.placeholder.com/640x480.png/00dd22?text=voluptatem",
        "data_ports": 7,
        "serialnumber1": "f71957ae-58d6-372a-8c3f-087ff73c39f3",
        "serialnumber2": "ceaf8bfa-23d3-36bf-9c36-f0630907b583",
        "service_tag": "417c79bd-5d16-353b-aca8-1348af6dbc9a",
        "comments": "Rem maxime similique aut. Ea laudantium eaque sunt placeat nulla est. Inventore praesentium neque et perspiciatis vel et. Voluptate est vitae quibusdam quibusdam natus asperiores aut.",
        "notes": "Itaque dolore cumque in. Adipisci enim dolor molestiae provident aliquid illum. Aliquid a corrupti alias rerum quas.",
        "purchase_date": "1972-08-17",
        "warranty_months": 28,
        "warranty_info": "Expedita ipsa unde quis tempore sit.",
        "function": "exercitationem",
        "maintenance_instruction": "Et consequatur quis ipsa incidunt sit. Sed illo aliquam nam repellendus ullam dolor aliquam quod. Dolore perferendis occaecati nihil ut quam. Voluptatibus accusamus praesentium provident.",
        "origin": "Korea",
        "buy_price": 330.72,
        "appdata": "a:1:{s:3:\"key\";s:10:\"blanditiis\";}",
        "fields_data": "a:1:{s:5:\"field\";s:10:\"aspernatur\";}",
        "parts_data": "a:1:{s:4:\"part\";s:8:\"pariatur\";}",
        "created_at": "2025-11-12T08:09:31.000000Z",
        "updated_at": "2025-11-12T08:09:31.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."
}

Request   

POST api/v3/admin/item-models

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The unique name of the item model. Must not be greater than 255 characters. Example: Dell PowerEdge R740

type_id   integer     

The type ID the model belongs to. The id of an existing record in the item_types table. Example: 1

location_id   integer  optional    

The location ID the model is associated with (optional). The id of an existing record in the locations table. Example: 5

label   string  optional    

A custom label for the model. Must not be greater than 255 characters. Example: High-Performance Server

status   string  optional    

The current status of the model. Must not be greater than 255 characters. Example: active

description   string  optional    

Detailed description of the model. Must not be greater than 1000 characters. Example: Dual CPU server with support for up to 3TB RAM.

is_part   boolean  optional    

Whether the model represents a part (1) or not (0). Example: false

mountable   boolean  optional    

Whether the model can be mounted (1) or not (0). Example: true

manufacturer   string  optional    

The name of the manufacturer. Must not be greater than 255 characters. Example: Dell

position   string  optional    

The default mounting position of the model in the rack. Allowed values: full, front, rear. Example: front

Must be one of:
  • full
  • front
  • rear
size   integer  optional    

Size in rack units. Must be at least 0. Example: 2

image   string  optional    

Must not be greater than 255 characters. Example: nuiztwlk

serialnumber1   string  optional    

Primary serial number field. Must not be greater than 255 characters. Example: SN123456789

serialnumber2   string  optional    

Secondary serial number field. Must not be greater than 255 characters. Example: SN987654321

service_tag   string  optional    

Service tag or asset tag. Must not be greater than 255 characters. Example: ST-001122

comments   string  optional    

Must not be greater than 1000 characters. Example: bvpc

notes   string  optional    

Must not be greater than 2000 characters. Example: bkwaoofakw

purchase_date   string  optional    

Must be a valid date. Example: 2025-11-12T09:09:31

warranty_months   integer  optional    

Warranty duration in months. Must be at least 0. Example: 36

warranty_info   string  optional    

Must not be greater than 500 characters. Example: gvhahywoengu

function   string  optional    

Must not be greater than 255 characters. Example: iahmmdxdxyfpxzlfkcsmgwak

maintenance_instruction   string  optional    

Must not be greater than 1000 characters. Example: ggxhtnsyzwsyhnqhkllotgu

origin   string  optional    

Must not be greater than 255 characters. Example: jojzqxbprszashlewvobpnhww

buy_price   number  optional    

Purchase price of the model. Must be at least 0. Example: 2500

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\": \"zqdvserqijhkdjbkbmqst\",
    \"serialnumber1\": \"SN123456789\",
    \"serialnumber2\": \"SN987654321\",
    \"service_tag\": \"ST-001122\",
    \"comments\": \"fwp\",
    \"notes\": \"hpkyjpzfqdljjjklhemtip\",
    \"purchase_date\": \"2025-11-12T09:09:31\",
    \"warranty_months\": 36,
    \"warranty_info\": \"hdocntzzkhfbwfalyzghxu\",
    \"function\": \"crlwbcqgkb\",
    \"maintenance_instruction\": \"fvlrn\",
    \"origin\": \"klqsmeaynwodpcpym\",
    \"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": "zqdvserqijhkdjbkbmqst",
    "serialnumber1": "SN123456789",
    "serialnumber2": "SN987654321",
    "service_tag": "ST-001122",
    "comments": "fwp",
    "notes": "hpkyjpzfqdljjjklhemtip",
    "purchase_date": "2025-11-12T09:09:31",
    "warranty_months": 36,
    "warranty_info": "hdocntzzkhfbwfalyzghxu",
    "function": "crlwbcqgkb",
    "maintenance_instruction": "fvlrn",
    "origin": "klqsmeaynwodpcpym",
    "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' => 'zqdvserqijhkdjbkbmqst',
            'serialnumber1' => 'SN123456789',
            'serialnumber2' => 'SN987654321',
            'service_tag' => 'ST-001122',
            'comments' => 'fwp',
            'notes' => 'hpkyjpzfqdljjjklhemtip',
            'purchase_date' => '2025-11-12T09:09:31',
            'warranty_months' => 36,
            'warranty_info' => 'hdocntzzkhfbwfalyzghxu',
            'function' => 'crlwbcqgkb',
            'maintenance_instruction' => 'fvlrn',
            'origin' => 'klqsmeaynwodpcpym',
            'buy_price' => 2500.0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 2473,
        "name": "maxime",
        "label": "amet",
        "type_id": 2990,
        "type": {
            "id": 2990,
            "name": "est"
        },
        "location_id": 5430,
        "status": "available",
        "description": "Praesentium in ipsa animi sunt laudantium deleniti.",
        "is_part": true,
        "mountable": false,
        "manufacturer": "Durgan-Friesen",
        "position": "sapiente",
        "size": 0,
        "image": "https://via.placeholder.com/640x480.png/0088ee?text=sint",
        "data_ports": 9,
        "serialnumber1": "29aedf1b-b9b2-36cb-b961-5572b5b8995d",
        "serialnumber2": "61fd9487-56d8-348e-b34a-76f84066aee3",
        "service_tag": "57e8b2ee-1171-39bd-9827-51876988f1ea",
        "comments": "Rerum et veniam deleniti et. Repellat praesentium voluptas quae quia ratione atque voluptatem. Et quod laboriosam vitae. Deserunt aliquid qui odio eius facilis.",
        "notes": "Iste et aut quam illum aliquid et tenetur. Dolore ut aut laboriosam eos dolores. Eum eveniet est alias. Quia pariatur quia laborum molestiae. Iusto sunt nihil officiis ut nam.",
        "purchase_date": "1975-10-24",
        "warranty_months": 17,
        "warranty_info": "Facilis ullam eaque id quasi impedit quod.",
        "function": "eaque",
        "maintenance_instruction": "Qui excepturi illo harum odio molestiae. Enim esse perferendis in reprehenderit beatae. Repellendus aut deserunt repellat aperiam nihil distinctio. Vitae doloremque ea unde velit ut.",
        "origin": "Luxembourg",
        "buy_price": 809.82,
        "appdata": "a:1:{s:3:\"key\";s:10:\"voluptatem\";}",
        "fields_data": "a:1:{s:5:\"field\";s:3:\"non\";}",
        "parts_data": "a:1:{s:4:\"part\";s:6:\"libero\";}",
        "created_at": "2025-11-12T08:09:32.000000Z",
        "updated_at": "2025-11-12T08:09:32.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."
}

Request   

PUT api/v3/admin/item-models/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item model. Example: 12

Body Parameters

name   string  optional    

The unique name of the item model. Must be unique across all models. Must not be greater than 255 characters. Example: Dell PowerEdge R740

type_id   integer  optional    

The type ID the model belongs to. The id of an existing record in the item_types table. Example: 1

location_id   integer  optional    

The location ID the model is associated with (optional). The id of an existing record in the locations table. Example: 5

label   string  optional    

A custom label for the model. Must not be greater than 255 characters. Example: High-Performance Server

status   string  optional    

The current status of the model. Must not be greater than 255 characters. Example: active

description   string  optional    

Detailed description of the model. Must not be greater than 1000 characters. Example: Dual CPU server with support for up to 3TB RAM.

is_part   boolean  optional    

Whether the model represents a part (1) or not (0). Example: false

mountable   boolean  optional    

Whether the model can be mounted (1) or not (0). Example: true

manufacturer   string  optional    

The name of the manufacturer. Must not be greater than 255 characters. Example: Dell

position   string  optional    

The default mounting position of the model in the rack. Allowed values: full, front, rear. Example: front

Must be one of:
  • full
  • front
  • rear
size   integer  optional    

Size in rack units. Must be at least 0. Example: 2

image   string  optional    

Must not be greater than 255 characters. Example: zqdvserqijhkdjbkbmqst

serialnumber1   string  optional    

Primary serial number field. Must not be greater than 255 characters. Example: SN123456789

serialnumber2   string  optional    

Secondary serial number field. Must not be greater than 255 characters. Example: SN987654321

service_tag   string  optional    

Service tag or asset tag. Must not be greater than 255 characters. Example: ST-001122

comments   string  optional    

Must not be greater than 1000 characters. Example: fwp

notes   string  optional    

Must not be greater than 2000 characters. Example: hpkyjpzfqdljjjklhemtip

purchase_date   string  optional    

Must be a valid date. Example: 2025-11-12T09:09:31

warranty_months   integer  optional    

Warranty duration in months. Must be at least 0. Example: 36

warranty_info   string  optional    

Must not be greater than 500 characters. Example: hdocntzzkhfbwfalyzghxu

function   string  optional    

Must not be greater than 255 characters. Example: crlwbcqgkb

maintenance_instruction   string  optional    

Must not be greater than 1000 characters. Example: fvlrn

origin   string  optional    

Must not be greater than 255 characters. Example: klqsmeaynwodpcpym

buy_price   number  optional    

Purchase price of the model. Must be at least 0. Example: 2500

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."
}

Request   

DELETE api/v3/admin/item-models/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item model. Example: 15

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": 9576,
            "username": "ullrich.sabina",
            "email": "[email protected]",
            "name": "Tianna Koepp",
            "firstname": "Tianna",
            "lastname": "Koepp",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/cd56aa08e4d68f4ff52eccf6cf85aa68?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/cd56aa08e4d68f4ff52eccf6cf85aa68?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": 9577,
            "username": "nicolas.wava",
            "email": "[email protected]",
            "name": "Josue Zulauf",
            "firstname": "Josue",
            "lastname": "Zulauf",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/80440f41f97a9a1026e727417beb2b4d?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/80440f41f97a9a1026e727417beb2b4d?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."
}

Request   

GET api/v3/admin/users

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, email, firstname, lastname, company, status. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, email, firstname, lastname, company, status. Example: id

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": 9578,
        "username": "juana.effertz",
        "email": "[email protected]",
        "name": "Haskell Boyle",
        "firstname": "Haskell",
        "lastname": "Boyle",
        "gender": "0",
        "avatar": "//www.gravatar.com/avatar/912c3b8b1dfcb87192e70d5f12d42e5d?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/912c3b8b1dfcb87192e70d5f12d42e5d?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."
}

Request   

GET api/v3/admin/users/find-by-email

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

The email address of the user to find. Example: [email protected]

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": 9579,
        "username": "manley.mann",
        "email": "[email protected]",
        "name": "Orville Collins",
        "firstname": "Orville",
        "lastname": "Collins",
        "devices": [],
        "orders": [],
        "gender": "0",
        "avatar": "//www.gravatar.com/avatar/d81cebab45a9920c93898dc871e4d367?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/d81cebab45a9920c93898dc871e4d367?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."
}

Request   

GET api/v3/admin/users/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 1

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": 9580,
        "username": "fstoltenberg",
        "email": "[email protected]",
        "name": "Julio Gleason",
        "firstname": "Julio",
        "lastname": "Gleason",
        "gender": "0",
        "avatar": "//www.gravatar.com/avatar/7cec7b211b5e018353ded6d7afd6d547?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/7cec7b211b5e018353ded6d7afd6d547?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."
}

Request   

POST api/v3/admin/users

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

username   string     

The username for the user. Must be unique. Example: johndoe

firstname   string     

The user's first name. Must not be greater than 255 characters. Example: John

lastname   string     

The user's last name. Must not be greater than 255 characters. Example: Doe

email   string     

The user's email address. Must be unique. Must be a valid email address. Example: [email protected]

password   string     

The user's password (minimum 6 characters). Must be at least 6 characters. Example: secret123

password_confirmation   string     

Confirmation of the password. Must match the password field. Must be at least 6 characters. Example: secret123

role   integer  optional    

The role ID to assign to the user. The id of an existing record in the roles table. Must not be one of 1. Example: 2

active   integer  optional    

User account status. Allowed values: 1 (active), 0 (inactive), -1 (banned). Example: 1

Must be one of:
  • 0
  • 1
  • -1
company   string  optional    

The company name associated with the user. Must not be greater than 255 characters. Example: Acme Inc.

date_of_birth   string  optional    

The user's date of birth in YYYY-MM-DD format. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 1990-05-15

address1   string  optional    

The first line of the user's street address. Example: 123 Main Street

address2   string  optional    

The second line of the user's street address (optional). Example: Apt 4B

city   string  optional    

The city where the user resides. Example: New York

state   string  optional    

The state or province of the user's address. Example: NY

postcode   string  optional    

The postal code or ZIP code of the user's address. Example: 10001

country_code   string  optional    

The ISO 3166-1 alpha-2 country code for the user's country. Must exist in the countries table. The code of an existing record in the countries table. Example: US

locale   string  optional    

The user's preferred locale/language code. Example: en

timezone   string  optional    

The user's timezone identifier. Must be a valid timezone. Must be a valid time zone, such as Africa/Accra. Must not be one of America/Coyhaique. Example: America/New_York

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": 9581,
        "username": "wellington.wuckert",
        "email": "[email protected]",
        "name": "Kasey Gutmann",
        "firstname": "Kasey",
        "lastname": "Gutmann",
        "gender": "0",
        "avatar": "//www.gravatar.com/avatar/faac4ae5022820ab1f3f771f4fdee807?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/faac4ae5022820ab1f3f771f4fdee807?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."
}

Request   

PUT api/v3/admin/users/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 1

Body Parameters

username   string  optional    

The username for the user. Must be unique. Example: johndoe

firstname   string  optional    

The user's first name. Must not be greater than 255 characters. Example: John

lastname   string  optional    

The user's last name. Must not be greater than 255 characters. Example: Doe

email   string  optional    

The user's email address. Must be unique. Must be a valid email address. Example: [email protected]

password   string  optional    

The user's password (minimum 6 characters). Must be at least 6 characters. Example: secret123

password_confirmation   string  optional    

Confirmation of the password. Must match the password field. This field is required when password is present. Must be at least 6 characters. Example: secret123

role   integer  optional    

The role ID to assign to the user. The id of an existing record in the roles table. Must not be one of 1. Example: 2

active   integer  optional    

User account status. Allowed values: 1 (active), 0 (inactive), -1 (suspended). Example: 1

Must be one of:
  • 0
  • 1
  • -1
company   string  optional    

The company name associated with the user. Must not be greater than 255 characters. Example: Acme Inc.

date_of_birth   string  optional    

The user's date of birth in YYYY-MM-DD format. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 1990-05-15

address1   string  optional    

The first line of the user's street address. Example: 123 Main Street

address2   string  optional    

The second line of the user's street address (optional). Example: Apt 4B

city   string  optional    

The city where the user resides. Example: New York

state   string  optional    

The state or province of the user's address. Example: NY

postcode   string  optional    

The postal code or ZIP code of the user's address. Example: 10001

country_code   string  optional    

The ISO 3166-1 alpha-2 country code for the user's country. Must exist in the countries table. The code of an existing record in the countries table. Example: US

locale   string  optional    

The user's preferred locale/language code. Example: en

timezone   string  optional    

The user's timezone identifier. Must be a valid timezone. Must be a valid time zone, such as Africa/Accra. Must not be one of America/Coyhaique. Example: America/New_York

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\",
    \"traffic_type\": \"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",
    "traffic_type": "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',
            'traffic_type' => '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."
}

Request   

POST api/v3/admin/users/{id}/bandwidth

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 1

Body Parameters

start_date   string     

The start date and time for the bandwidth report. Must be a valid date. Example: 2025-09-22 00:00:00

end_date   string     

The end date and time for the bandwidth report. Must be a valid date. Example: 2025-09-22 23:59:59

traffic_type   string  optional    

The type of traffic to report. Allowed values: all, server, order. Default value is all. Example: all

Must be one of:
  • all
  • server
  • order

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."
}

Request   

DELETE api/v3/admin/users/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 5

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."
}

Request   

POST api/v3/admin/users/verify-token-ability

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

ability   string     

The ability (permission) name to verify for the current token. Must not be greater than 128 characters. Example: impersonate-users

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": 46407,
            "name": null,
            "description": "Accusantium non quisquam voluptatem iure velit.",
            "item_id": 1674,
            "colocation_id": 0,
            "connected_item": null,
            "connected_port": null,
            "port_number": 37,
            "port_index": 23,
            "port_mode": "trunk",
            "port_label": "rerum",
            "user_label": "ut",
            "speed": "1000",
            "high_speed": "100",
            "if_type": "177",
            "physaddress": "BC:B1:96:89:DA:68",
            "pullable": 0,
            "primary": 1,
            "vlan": 127,
            "opstate": "down",
            "adminstate": "down",
            "type": "",
            "ifInUcastPkts": 409,
            "ifInUcastPkts_prev": null,
            "ifOutUcastPkts": 3160,
            "ifOutUcastPkts_prev": null,
            "ifInErrors": 0,
            "ifInErrors_prev": null,
            "ifOutErrors": 0,
            "ifOutErrors_prev": null,
            "ifInOctets": 0,
            "ifInOctets_prev": null,
            "ifOutOctets": 0,
            "ifOutOctets_prev": null,
            "poll_time": 2025,
            "poll_prev": 0,
            "poll_period": 300,
            "created_at": "2025-11-12 09:09:33",
            "updated_at": "2025-11-12 09:09:33"
        },
        {
            "id": 46408,
            "name": null,
            "description": "Quidem eveniet sed quae laboriosam.",
            "item_id": 1675,
            "colocation_id": 0,
            "connected_item": null,
            "connected_port": null,
            "port_number": 45,
            "port_index": 19,
            "port_mode": "trunk",
            "port_label": "quia",
            "user_label": "quo",
            "speed": "100",
            "high_speed": "1000",
            "if_type": "14",
            "physaddress": "1E:9B:47:CF:75:99",
            "pullable": 1,
            "primary": 1,
            "vlan": 127,
            "opstate": "up",
            "adminstate": "up",
            "type": "",
            "ifInUcastPkts": 9786,
            "ifInUcastPkts_prev": null,
            "ifOutUcastPkts": 1982,
            "ifOutUcastPkts_prev": null,
            "ifInErrors": 0,
            "ifInErrors_prev": null,
            "ifOutErrors": 0,
            "ifOutErrors_prev": null,
            "ifInOctets": 0,
            "ifInOctets_prev": null,
            "ifOutOctets": 0,
            "ifOutOctets_prev": null,
            "poll_time": 2025,
            "poll_prev": 0,
            "poll_period": 300,
            "created_at": "2025-11-12 09:09:33",
            "updated_at": "2025-11-12 09:09:33"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://your-easydcim.com/api/v3/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."
}

Request   

GET api/v3/admin/ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description. Example: id

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\": false,
    \"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": false,
    "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' => false,
            '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": 46409,
        "name": null,
        "description": "In sint tempora iusto rerum et exercitationem quam distinctio.",
        "item": {
            "id": 1677,
            "name": null,
            "label": "non",
            "type_id": 2997,
            "location_id": 5440,
            "status": "available",
            "description": "Voluptas magnam nesciunt sit.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Feeney and Sons",
            "position": null,
            "size": 2,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN219EG",
            "serialnumber2": null,
            "service_tag": "ST695RR",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:35.000000Z",
            "updated_at": "2025-11-12T08:09:35.000000Z"
        },
        "colocation": null,
        "connected_item": null,
        "connected_port": null,
        "port_number": 9,
        "port_index": 11,
        "port_mode": "access",
        "port_label": "reiciendis",
        "user_label": "aliquam",
        "speed": "100",
        "high_speed": "10000",
        "if_type": "111",
        "physaddress": "3C:30:2F:5D:A9:91",
        "pullable": 0,
        "primary": 0,
        "vlan": 127,
        "opstate": "up",
        "adminstate": "up",
        "type": "",
        "ifInUcastPkts": 9954,
        "ifInUcastPkts_prev": null,
        "ifOutUcastPkts": 8463,
        "ifOutUcastPkts_prev": null,
        "ifInErrors": 0,
        "ifInErrors_prev": null,
        "ifOutErrors": 0,
        "ifOutErrors_prev": null,
        "ifInOctets": 0,
        "ifInOctets_prev": null,
        "ifOutOctets": 0,
        "ifOutOctets_prev": null,
        "poll_time": 2025,
        "poll_prev": 0,
        "poll_period": 300,
        "created_at": "2025-11-12 09:09:36",
        "updated_at": "2025-11-12 09:09:36"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

port_number   integer     

The number of the port. Must be at least 1. Example: 1

device_id   integer     

Device Id for which port should be created. The id of an existing record in the items table. Example: 115

port_label   string  optional    

The label of the port. Must not be greater than 255 characters. Example: 32

if_type   integer  optional    

Type of the port. Port types: 1 => other, 2 => regular1822, 3 => hdh1822, 4 => ddnX25, 5 => rfc877x25, 6 => ethernetCsmacd, 7 => iso88023Csmacd, 8 => iso88024TokenBus, 9 => iso88025TokenRing, 10 => iso88026Man, 11 => starLan, 12 => proteon10Mbit, 13 => proteon80Mbit, 14 => hyperchannel, 15 => fddi, 16 => lapb, 17 => sdlc, 18 => ds1, 19 => e1, 20 => basicISDN, 21 => primaryISDN, 22 => propPointToPointSerial, 23 => ppp, 24 => softwareLoopback, 25 => eon, 26 => ethernet3Mbit, 27 => nsip, 28 => slip, 29 => ultra, 30 => ds3, 31 => sip, 32 => frameRelay, 33 => rs232, 34 => para, 35 => arcnet, 36 => arcnetPlus, 37 => atm, 38 => miox25, 39 => sonet, 40 => x25ple, 41 => iso88022llc, 42 => localTalk, 43 => smdsDxi, 44 => frameRelayService, 45 => v35, 46 => hssi, 47 => hippi, 48 => modem, 49 => aal5, 50 => sonetPath, 51 => sonetVT, 52 => smdsIcip, 53 => propVirtual, 54 => propMultiplexor, 55 => ieee80212, 56 => fibreChannel, 57 => hippiInterface, 58 => frameRelayInterconnect, 59 => aflane8023, 60 => aflane8025, 61 => cctEmul, 62 => fastEther, 63 => isdn, 64 => v11, 65 => v36, 66 => g703at64k, 67 => g703at2mb, 68 => qllc, 69 => fastEtherFX, 70 => channel, 71 => ieee80211, 72 => ibm370parChan, 73 => escon, 74 => dlsw, 75 => isdns, 76 => isdnu, 77 => lapd, 78 => ipSwitch, 79 => rsrb, 80 => atmLogical, 81 => ds0, 82 => ds0Bundle, 83 => bsc, 84 => async, 85 => cnr, 86 => iso88025Dtr, 87 => eplrs, 88 => arap, 89 => propCnls, 90 => hostPad, 91 => termPad, 92 => frameRelayMPI, 93 => x213, 94 => adsl, 95 => radsl, 96 => sdsl, 97 => vdsl, 98 => iso88025CRFPInt, 99 => myrinet, 100 => voiceEM, 101 => voiceFXO, 102 => voiceFXS, 103 => voiceEncap, 104 => voiceOverIp, 105 => atmDxi, 106 => atmFuni, 107 => atmIma, 108 => pppMultilinkBundle, 109 => ipOverCdlc, 110 => ipOverClaw, 111 => stackToStack, 112 => virtualIpAddress, 113 => mpc, 114 => ipOverAtm, 115 => iso88025Fiber, 116 => tdlc, 117 => gigabitEthernet, 118 => hdlc, 119 => lapf, 120 => v37, 121 => x25mlp, 122 => x25huntGroup, 123 => trasnpHdlc, 124 => interleave, 125 => fast, 126 => ip, 127 => docsCableMaclayer, 128 => docsCableDownstream, 129 => docsCableUpstream, 130 => a12MppSwitch, 131 => tunnel, 132 => coffee, 133 => ces, 134 => atmSubInterface, 135 => l2vlan, 136 => l3ipvlan, 137 => l3ipxvlan, 138 => digitalPowerline, 139 => mediaMailOverIp, 140 => dtm, 141 => dcn, 142 => ipForward, 143 => msdsl, 144 => ieee1394, 145 => if-gsn, 146 => dvbRccMacLayer, 147 => dvbRccDownstream, 148 => dvbRccUpstream, 149 => atmVirtual, 150 => mplsTunnel, 151 => srp, 152 => voiceOverAtm, 153 => voiceOverFrameRelay, 154 => idsl, 155 => compositeLink, 156 => ss7SigLink, 157 => propWirelessP2P, 158 => frForward, 159 => rfc1483, 160 => usb, 161 => ieee8023adLag, 162 => bgppolicyaccounting, 163 => frf16MfrBundle, 164 => h323Gatekeeper, 165 => h323Proxy, 166 => mpls, 167 => mfSigLink, 168 => hdsl2, 169 => shdsl, 170 => ds1FDL, 171 => pos, 172 => dvbAsiIn, 173 => dvbAsiOut, 174 => plc, 175 => nfas, 176 => tr008, 177 => gr303RDT, 178 => gr303IDT, 179 => isup, 180 => propDocsWirelessMaclayer, 181 => propDocsWirelessDownstream, 182 => propDocsWirelessUpstream, 183 => hiperlan2, 184 => propBWAp2Mp, 185 => sonetOverheadChannel, 186 => digitalWrapperOverheadChannel, 187 => aal2, 188 => radioMAC, 189 => atmRadio, 190 => imt, 191 => mvl, 192 => reachDSL, 193 => frDlciEndPt, 194 => atmVciEndPt, 195 => opticalChannel, 196 => opticalTransport, 197 => propAtm, 198 => voiceOverCable, 199 => infiniband, 200 => teLink, 201 => q2931, 202 => virtualTg, 203 => sipTg, 204 => sipSig, 205 => docsCableUpstreamChannel, 206 => econet, 207 => pon155, 208 => pon622, 209 => bridge, 210 => linegroup, 211 => voiceEMFGD, 212 => voiceFGDEANA, 213 => voiceDID, 214 => mpegTransport, 215 => sixToFour, 216 => gtp, 217 => pdnEtherLoop1, 218 => pdnEtherLoop2, 219 => opticalChannelGroup, 220 => homepna, 221 => gfp, 222 => ciscoISLvlan, 223 => actelisMetaLOOP, 224 => fcipLink, 225 => rpr, 226 => qam, 227 => lmp, 228 => cblVectaStar, 229 => docsCableMCmtsDownstream, 230 => adsl2, 231 => macSecControlledIF, 232 => macSecUncontrolledIF, 233 => aviciOpticalEther, 234 => atmbond. Example: 1

Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
pullable   boolean  optional    

Determine if the port is pullable. Example: false

description   string  optional    

The description of the port. Example: This is description of the port

user_label   string  optional    

The user label of the port. Example: Uplink port

physaddress   string  optional    

The physical address of the port. Example: 00:0a:95:9d:68:16

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\": false,
    \"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": false,
    "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' => false,
            '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": 46410,
        "name": null,
        "description": "Expedita provident fugiat eos nostrum autem qui.",
        "item": {
            "id": 1678,
            "name": null,
            "label": "temporibus",
            "type_id": 2999,
            "location_id": 5442,
            "status": "available",
            "description": "Est voluptas ex et aut quisquam.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Rowe PLC",
            "position": null,
            "size": 2,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN717CN",
            "serialnumber2": null,
            "service_tag": "ST137WJ",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:36.000000Z",
            "updated_at": "2025-11-12T08:09:36.000000Z"
        },
        "colocation": null,
        "connected_item": null,
        "connected_port": null,
        "port_number": 29,
        "port_index": 77,
        "port_mode": "access",
        "port_label": "assumenda",
        "user_label": "repellat",
        "speed": "10000",
        "high_speed": "100",
        "if_type": "205",
        "physaddress": "E7:9B:E4:81:C7:8E",
        "pullable": 0,
        "primary": 1,
        "vlan": 127,
        "opstate": "up",
        "adminstate": "down",
        "type": "",
        "ifInUcastPkts": 1147,
        "ifInUcastPkts_prev": null,
        "ifOutUcastPkts": 371,
        "ifOutUcastPkts_prev": null,
        "ifInErrors": 0,
        "ifInErrors_prev": null,
        "ifOutErrors": 0,
        "ifOutErrors_prev": null,
        "ifInOctets": 0,
        "ifInOctets_prev": null,
        "ifOutOctets": 0,
        "ifOutOctets_prev": null,
        "poll_time": 2025,
        "poll_prev": 0,
        "poll_period": 300,
        "created_at": "2025-11-12 09:09:37",
        "updated_at": "2025-11-12 09:09:37"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/ports/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 1

Body Parameters

port_number   integer     

The number of the port. Must be at least 1. Example: 1

port_label   string  optional    

The label of the port. Must not be greater than 255 characters. Example: 32

if_type   integer  optional    

Type of the port. Port types: 1 => other, 2 => regular1822, 3 => hdh1822, 4 => ddnX25, 5 => rfc877x25, 6 => ethernetCsmacd, 7 => iso88023Csmacd, 8 => iso88024TokenBus, 9 => iso88025TokenRing, 10 => iso88026Man, 11 => starLan, 12 => proteon10Mbit, 13 => proteon80Mbit, 14 => hyperchannel, 15 => fddi, 16 => lapb, 17 => sdlc, 18 => ds1, 19 => e1, 20 => basicISDN, 21 => primaryISDN, 22 => propPointToPointSerial, 23 => ppp, 24 => softwareLoopback, 25 => eon, 26 => ethernet3Mbit, 27 => nsip, 28 => slip, 29 => ultra, 30 => ds3, 31 => sip, 32 => frameRelay, 33 => rs232, 34 => para, 35 => arcnet, 36 => arcnetPlus, 37 => atm, 38 => miox25, 39 => sonet, 40 => x25ple, 41 => iso88022llc, 42 => localTalk, 43 => smdsDxi, 44 => frameRelayService, 45 => v35, 46 => hssi, 47 => hippi, 48 => modem, 49 => aal5, 50 => sonetPath, 51 => sonetVT, 52 => smdsIcip, 53 => propVirtual, 54 => propMultiplexor, 55 => ieee80212, 56 => fibreChannel, 57 => hippiInterface, 58 => frameRelayInterconnect, 59 => aflane8023, 60 => aflane8025, 61 => cctEmul, 62 => fastEther, 63 => isdn, 64 => v11, 65 => v36, 66 => g703at64k, 67 => g703at2mb, 68 => qllc, 69 => fastEtherFX, 70 => channel, 71 => ieee80211, 72 => ibm370parChan, 73 => escon, 74 => dlsw, 75 => isdns, 76 => isdnu, 77 => lapd, 78 => ipSwitch, 79 => rsrb, 80 => atmLogical, 81 => ds0, 82 => ds0Bundle, 83 => bsc, 84 => async, 85 => cnr, 86 => iso88025Dtr, 87 => eplrs, 88 => arap, 89 => propCnls, 90 => hostPad, 91 => termPad, 92 => frameRelayMPI, 93 => x213, 94 => adsl, 95 => radsl, 96 => sdsl, 97 => vdsl, 98 => iso88025CRFPInt, 99 => myrinet, 100 => voiceEM, 101 => voiceFXO, 102 => voiceFXS, 103 => voiceEncap, 104 => voiceOverIp, 105 => atmDxi, 106 => atmFuni, 107 => atmIma, 108 => pppMultilinkBundle, 109 => ipOverCdlc, 110 => ipOverClaw, 111 => stackToStack, 112 => virtualIpAddress, 113 => mpc, 114 => ipOverAtm, 115 => iso88025Fiber, 116 => tdlc, 117 => gigabitEthernet, 118 => hdlc, 119 => lapf, 120 => v37, 121 => x25mlp, 122 => x25huntGroup, 123 => trasnpHdlc, 124 => interleave, 125 => fast, 126 => ip, 127 => docsCableMaclayer, 128 => docsCableDownstream, 129 => docsCableUpstream, 130 => a12MppSwitch, 131 => tunnel, 132 => coffee, 133 => ces, 134 => atmSubInterface, 135 => l2vlan, 136 => l3ipvlan, 137 => l3ipxvlan, 138 => digitalPowerline, 139 => mediaMailOverIp, 140 => dtm, 141 => dcn, 142 => ipForward, 143 => msdsl, 144 => ieee1394, 145 => if-gsn, 146 => dvbRccMacLayer, 147 => dvbRccDownstream, 148 => dvbRccUpstream, 149 => atmVirtual, 150 => mplsTunnel, 151 => srp, 152 => voiceOverAtm, 153 => voiceOverFrameRelay, 154 => idsl, 155 => compositeLink, 156 => ss7SigLink, 157 => propWirelessP2P, 158 => frForward, 159 => rfc1483, 160 => usb, 161 => ieee8023adLag, 162 => bgppolicyaccounting, 163 => frf16MfrBundle, 164 => h323Gatekeeper, 165 => h323Proxy, 166 => mpls, 167 => mfSigLink, 168 => hdsl2, 169 => shdsl, 170 => ds1FDL, 171 => pos, 172 => dvbAsiIn, 173 => dvbAsiOut, 174 => plc, 175 => nfas, 176 => tr008, 177 => gr303RDT, 178 => gr303IDT, 179 => isup, 180 => propDocsWirelessMaclayer, 181 => propDocsWirelessDownstream, 182 => propDocsWirelessUpstream, 183 => hiperlan2, 184 => propBWAp2Mp, 185 => sonetOverheadChannel, 186 => digitalWrapperOverheadChannel, 187 => aal2, 188 => radioMAC, 189 => atmRadio, 190 => imt, 191 => mvl, 192 => reachDSL, 193 => frDlciEndPt, 194 => atmVciEndPt, 195 => opticalChannel, 196 => opticalTransport, 197 => propAtm, 198 => voiceOverCable, 199 => infiniband, 200 => teLink, 201 => q2931, 202 => virtualTg, 203 => sipTg, 204 => sipSig, 205 => docsCableUpstreamChannel, 206 => econet, 207 => pon155, 208 => pon622, 209 => bridge, 210 => linegroup, 211 => voiceEMFGD, 212 => voiceFGDEANA, 213 => voiceDID, 214 => mpegTransport, 215 => sixToFour, 216 => gtp, 217 => pdnEtherLoop1, 218 => pdnEtherLoop2, 219 => opticalChannelGroup, 220 => homepna, 221 => gfp, 222 => ciscoISLvlan, 223 => actelisMetaLOOP, 224 => fcipLink, 225 => rpr, 226 => qam, 227 => lmp, 228 => cblVectaStar, 229 => docsCableMCmtsDownstream, 230 => adsl2, 231 => macSecControlledIF, 232 => macSecUncontrolledIF, 233 => aviciOpticalEther, 234 => atmbond. Example: 1

Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
pullable   boolean  optional    

Determine if the port is pullable. Example: false

description   string  optional    

The description of the port. Example: This is description of the port

user_label   string  optional    

The user label of the port. Example: Uplink port

physaddress   string  optional    

The physical address of the port. Example: 00:0a:95:9d:68:16

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": 46411,
        "name": null,
        "description": "Quas consequatur eum quo quia cupiditate rem.",
        "item": {
            "id": 1679,
            "name": null,
            "label": "ut",
            "type_id": 3001,
            "location_id": 5444,
            "status": "available",
            "description": "Sit in aliquid perferendis odio.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Dickens, Zboncak and Kemmer",
            "position": null,
            "size": 4,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN613VJ",
            "serialnumber2": null,
            "service_tag": "ST699FH",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:37.000000Z",
            "updated_at": "2025-11-12T08:09:37.000000Z"
        },
        "colocation": null,
        "connected_item": null,
        "connected_port": null,
        "port_number": 15,
        "port_index": 95,
        "port_mode": "trunk",
        "port_label": "quibusdam",
        "user_label": "molestiae",
        "speed": "1000",
        "high_speed": "100",
        "if_type": "121",
        "physaddress": "58:86:47:50:77:14",
        "pullable": 1,
        "primary": 0,
        "vlan": 127,
        "opstate": "down",
        "adminstate": "up",
        "type": "",
        "ifInUcastPkts": 4762,
        "ifInUcastPkts_prev": null,
        "ifOutUcastPkts": 4121,
        "ifOutUcastPkts_prev": null,
        "ifInErrors": 0,
        "ifInErrors_prev": null,
        "ifOutErrors": 0,
        "ifOutErrors_prev": null,
        "ifInOctets": 0,
        "ifInOctets_prev": null,
        "ifOutOctets": 0,
        "ifOutOctets_prev": null,
        "poll_time": 2025,
        "poll_prev": 0,
        "poll_period": 300,
        "created_at": "2025-11-12 09:09:38",
        "updated_at": "2025-11-12 09:09:38"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/ports/{id}/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 1

Body Parameters

connected_item   integer     

Item id of connected item. The id of an existing record in the items table. Example: 12

connected_port   integer     

Port Id of connected port. The id of an existing record in the item_ports table. Example: 115

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": 46412,
        "name": null,
        "description": "Veritatis quae error explicabo minus reiciendis veritatis voluptatem sit.",
        "item": {
            "id": 1680,
            "name": null,
            "label": "maxime",
            "type_id": 3003,
            "location_id": 5446,
            "status": "available",
            "description": "Non ipsam aut doloremque deleniti.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Goodwin, Keebler and Durgan",
            "position": null,
            "size": 1,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN571YZ",
            "serialnumber2": null,
            "service_tag": "ST146GR",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:38.000000Z",
            "updated_at": "2025-11-12T08:09:38.000000Z"
        },
        "colocation": null,
        "connected_item": null,
        "connected_port": null,
        "port_number": 7,
        "port_index": 42,
        "port_mode": "access",
        "port_label": "dolor",
        "user_label": "consequuntur",
        "speed": "100",
        "high_speed": "100",
        "if_type": "48",
        "physaddress": "BB:22:6A:D4:4B:B8",
        "pullable": 0,
        "primary": 1,
        "vlan": 127,
        "opstate": "down",
        "adminstate": "down",
        "type": "",
        "ifInUcastPkts": 933,
        "ifInUcastPkts_prev": null,
        "ifOutUcastPkts": 4706,
        "ifOutUcastPkts_prev": null,
        "ifInErrors": 0,
        "ifInErrors_prev": null,
        "ifOutErrors": 0,
        "ifOutErrors_prev": null,
        "ifInOctets": 0,
        "ifInOctets_prev": null,
        "ifOutOctets": 0,
        "ifOutOctets_prev": null,
        "poll_time": 2025,
        "poll_prev": 0,
        "poll_period": 300,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/ports/{id}/unassign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 1

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."
}

Request   

POST api/v3/admin/ports/{id}/enable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 1

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."
}

Request   

POST api/v3/admin/ports/{id}/disable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 1

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."
}

Request   

DELETE api/v3/admin/ports/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the port. Example: 5

Power Ports

Show Power Port

requires authentication

Display detailed information about a single power port by its ID.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/ports/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/ports/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ports/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 542,
        "name": "laboriosam",
        "description": "Molestiae rerum tempora eaque itaque est ea at sunt.",
        "item": {
            "id": 1676,
            "name": null,
            "label": "quis",
            "type_id": 2995,
            "location_id": 5436,
            "status": "available",
            "description": "Et dolorem vero atque voluptatem iure.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Olson and Sons",
            "position": null,
            "size": 1,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN490CS",
            "serialnumber2": null,
            "service_tag": "ST812UO",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:33.000000Z",
            "updated_at": "2025-11-12T08:09:33.000000Z"
        },
        "colocation": null,
        "port_number": 13,
        "port_label": "quisquam",
        "user_label": "optio",
        "outlet_state": "outletOn",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 3,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:09:33",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

GET api/v3/admin/ports/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 1

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": 543,
            "name": "modi",
            "description": "Sed fugiat eligendi aliquid deserunt ut et sunt.",
            "item_id": 1697,
            "colocation_id": 0,
            "port_number": 37,
            "port_label": "officiis",
            "user_label": "temporibus",
            "outlet_state": "down",
            "connected_item": null,
            "connected_port": null,
            "power_usage": 17,
            "power_usage_units": "Amps",
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        },
        {
            "id": 544,
            "name": "eum",
            "description": "Est incidunt consequatur distinctio ut consequuntur earum.",
            "item_id": 1698,
            "colocation_id": 0,
            "port_number": 47,
            "port_label": "voluptatibus",
            "user_label": "eligendi",
            "outlet_state": "down",
            "connected_item": null,
            "connected_port": null,
            "power_usage": 76,
            "power_usage_units": "Amps",
            "created_at": "2025-11-12 09:09:53",
            "updated_at": "2025-11-12 09:09: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/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."
}

Request   

GET api/v3/admin/power-ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description. Example: id

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\": false,
    \"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": false,
    "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' => false,
            '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": 545,
        "name": "placeat",
        "description": "Voluptatum deserunt sit aliquam quo maiores laborum dolorem.",
        "item": null,
        "colocation": null,
        "port_number": 29,
        "port_label": "cumque",
        "user_label": "occaecati",
        "outlet_state": "up",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 91,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:09:54",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/power-ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

port_number   integer     

The number of the power port. Must be at least 1. Example: 1

device_id   integer     

Device Id for which power port should be created. The id of an existing record in the items table. Example: 115

port_label   string  optional    

The label of the power port. Must not be greater than 255 characters. Example: Power Port 1

primary   boolean  optional    

Determine if the power port is primary. Example: false

description   string  optional    

The description of the power port. Example: This is description of the power port

user_label   string  optional    

The user label of the power port. Example: Description of power port

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\": false,
    \"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": false,
    "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' => false,
            '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": 546,
        "name": "aspernatur",
        "description": "Hic sunt modi id voluptas facere in.",
        "item": {
            "id": 1700,
            "name": null,
            "label": "perferendis",
            "type_id": 3043,
            "location_id": 5492,
            "status": "available",
            "description": "Ab enim ipsa vero omnis possimus suscipit quia.",
            "is_part": false,
            "mountable": true,
            "manufacturer": "Conn-Schmitt",
            "position": null,
            "size": 1,
            "image": null,
            "data_ports": 0,
            "serialnumber1": "SN503SS",
            "serialnumber2": null,
            "service_tag": "ST187NS",
            "comments": null,
            "notes": null,
            "purchase_date": "2024-11-12",
            "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": "2025-11-12T08:09:56.000000Z",
            "updated_at": "2025-11-12T08:09:56.000000Z"
        },
        "colocation": null,
        "port_number": 1,
        "port_label": "adipisci",
        "user_label": "rem",
        "outlet_state": "up",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 42,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:09:56",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

PUT api/v3/admin/power-ports/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 1

Body Parameters

port_number   integer  optional    

The number of the power port. Must be at least 1. Example: 1

port_label   string  optional    

The label of the power port. Must not be greater than 255 characters. Example: 32

primary   boolean  optional    

Determine if the power port is primary. Example: false

description   string  optional    

The description of the power port. Example: This is description of the power port

user_label   string  optional    

The user label of the power port. Example: Description of power port

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": 547,
        "name": "repellendus",
        "description": "In et accusamus temporibus voluptas eos qui quos.",
        "item": null,
        "colocation": null,
        "port_number": 46,
        "port_label": "non",
        "user_label": "dolores",
        "outlet_state": "outletOff",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 15,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:09:57",
        "updated_at": "2025-11-12 09:09:57"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/power-ports/{id}/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 1

Body Parameters

connected_item   integer     

Item id of connected item. The id of an existing record in the items table. Example: 12

connected_port   integer     

Port Id of connected port. The id of an existing record in the item_power_ports table. Example: 115

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": 548,
        "name": "tempore",
        "description": "Tenetur nulla rem nobis.",
        "item": null,
        "colocation": null,
        "port_number": 2,
        "port_label": "et",
        "user_label": "culpa",
        "outlet_state": "outletOn",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 10,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:09:59",
        "updated_at": "2025-11-12 09:09:59"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/power-ports/{id}/unassign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 1

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": 549,
        "name": "velit",
        "description": "Ipsum eius voluptatem voluptatem.",
        "item": null,
        "colocation": null,
        "port_number": 8,
        "port_label": "voluptatem",
        "user_label": "omnis",
        "outlet_state": "outletOff",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 80,
        "power_usage_units": "Amps",
        "created_at": "2025-11-12 09:10:00",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

POST api/v3/admin/power-ports/{id}/action

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 1

Body Parameters

action   string     

The outlet action to perform. Must be one of: outletOn, outletOff, outletReboot. Example: outletOff

Must be one of:
  • outletOn
  • outletOff
  • outletReboot

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."
}

Request   

DELETE api/v3/admin/power-ports/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the power port. Example: 5

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": 1064,
            "ordernumber": 546470,
            "user_id": 9607,
            "status": "pending",
            "service_status": "waiting",
            "type": "Colocation",
            "options": {
                "autostart": true
            },
            "service": null,
            "created_at": "2025-11-12 09:09:39",
            "updated_at": "2025-11-12 09:09:39"
        },
        {
            "id": 1065,
            "ordernumber": 30404,
            "user_id": 9608,
            "status": "accepted",
            "service_status": "provisioning",
            "type": "Colocation",
            "options": {
                "autostart": true
            },
            "service": null,
            "created_at": "2025-11-12 09:09:39",
            "updated_at": "2025-11-12 09:09:39"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://your-easydcim.com/api/v3/admin/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."
}

Request   

GET api/v3/admin/orders

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, ordernumber, status, service_status, type, user_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, ordernumber, status, service_status, type, user_id. Example: id

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/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/orders/3'
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/3';
$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": 1066,
        "ordernumber": 318628,
        "user_id": 9609,
        "status": "accepted",
        "service_status": "suspended",
        "type": "Colocation",
        "options": {
            "autostart": true
        },
        "service": null,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

GET api/v3/admin/orders/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 3

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\": false,
    \"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
                ]
            }
        }
    },
    \"service\": {
        \"hostname\": \"vps.local\",
        \"template\": 3,
        \"username\": \"user\",
        \"password\": \"pass\"
    },
    \"other\": {
        \"custom_device\": 171
    },
    \"actions\": {
        \"activate\": [
            \"boot\",
            \"ports\",
            \"add_rdns\"
        ],
        \"suspend\": [
            \"shutdown\",
            \"ports\"
        ],
        \"unsuspend\": [
            \"boot\",
            \"ports\"
        ],
        \"terminate\": [
            \"shutdown\",
            \"ports\",
            \"remove_dns\"
        ]
    }
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/orders'
payload = {
    "module": "Server",
    "client": 1,
    "auto_accept": false,
    "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
                ]
            }
        }
    },
    "service": {
        "hostname": "vps.local",
        "template": 3,
        "username": "user",
        "password": "pass"
    },
    "other": {
        "custom_device": 171
    },
    "actions": {
        "activate": [
            "boot",
            "ports",
            "add_rdns"
        ],
        "suspend": [
            "shutdown",
            "ports"
        ],
        "unsuspend": [
            "boot",
            "ports"
        ],
        "terminate": [
            "shutdown",
            "ports",
            "remove_dns"
        ]
    }
}
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' => false,
            '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,
                        ],
                    ],
                ],
            ],
            'service' => [
                'hostname' => 'vps.local',
                'template' => 3,
                'username' => 'user',
                'password' => 'pass',
            ],
            'other' => [
                'custom_device' => 171,
            ],
            'actions' => [
                'activate' => [
                    'boot',
                    'ports',
                    'add_rdns',
                ],
                'suspend' => [
                    'shutdown',
                    'ports',
                ],
                'unsuspend' => [
                    'boot',
                    'ports',
                ],
                'terminate' => [
                    'shutdown',
                    'ports',
                    'remove_dns',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 1067,
        "ordernumber": 174685,
        "user_id": 9610,
        "status": "pending",
        "service_status": "suspended",
        "type": "Server",
        "options": {
            "autostart": true
        },
        "service": null,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/orders

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

module   string     

The provisioning module to use for the order. Allowed values: Server, Colocation. Example: Server

Must be one of:
  • Server
  • Colocation
client   integer     

The ID of the client creating the order. The id of an existing record in the users table. Example: 1

auto_accept   boolean  optional    

Whether the order should be automatically accepted and the service provisioned. Example: false

criteria   object  optional    

Criteria for selecting the device or resources. Can include model, location, parts, metadata, etc.

service   object  optional    

Service configuration details like hostname, template, username, password, etc.

other   object  optional    

Additional parameters such as custom device selection.

actions   object  optional    

Lifecycle actions configuration for the service (activate, suspend, unsuspend, terminate).

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": 1068,
        "ordernumber": 955704,
        "user_id": 9611,
        "status": "pending",
        "service_status": "waiting",
        "type": "Server",
        "options": {
            "autostart": true
        },
        "service": null,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/orders/quick-create

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

module   string     

The provisioning module to use for the order. Allowed values: Server, Colocation. Example: Server

Must be one of:
  • Server
  • Colocation
client   integer     

The ID of the client creating the order. The id of an existing record in the users table. Example: 1

device_id   integer     

The ID of the device to assign to the order. The device must be available and not assigned to another customer. The id of an existing record in the items table. Example: 10

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,
    \"criteria\": {
        \"model\": 12,
        \"location\": 12,
        \"require_parts\": 1
    },
    \"service\": {
        \"hostname\": \"updated-vps.local\",
        \"template\": 4
    },
    \"other\": {
        \"custom_device\": 171
    }
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/orders/123'
payload = {
    "client": 1,
    "criteria": {
        "model": 12,
        "location": 12,
        "require_parts": 1
    },
    "service": {
        "hostname": "updated-vps.local",
        "template": 4
    },
    "other": {
        "custom_device": 171
    }
}
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,
            'criteria' => [
                'model' => 12,
                'location' => 12,
                'require_parts' => 1,
            ],
            'service' => [
                'hostname' => 'updated-vps.local',
                'template' => 4,
            ],
            'other' => [
                'custom_device' => 171,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 1069,
        "ordernumber": 456450,
        "user_id": 9612,
        "status": "accepted",
        "service_status": "terminated",
        "type": "Server",
        "options": {
            "autostart": true
        },
        "service": null,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

PUT api/v3/admin/orders/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 123

Body Parameters

client   integer  optional    

The ID of the client assigned to the order. The id of an existing record in the users table. Example: 1

criteria   object  optional    

Updated provisioning criteria (model, location, parts, metadata, etc).

service   object  optional    

Updated service configuration.

other   object  optional    

Additional parameters such as custom device selection.

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."
}

Request   

DELETE api/v3/admin/orders/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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": 1070,
        "ordernumber": 220923,
        "user_id": 9613,
        "status": "accepted",
        "service_status": "waiting",
        "type": "Server",
        "options": {
            "autostart": true
        },
        "service": null,
        "created_at": "2025-11-12 09:09:39",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/orders/{id}/accept

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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."
}

Request   

POST api/v3/admin/orders/{id}/service/activate

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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."
}

Request   

POST api/v3/admin/orders/{id}/service/suspend

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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."
}

Request   

POST api/v3/admin/orders/{id}/service/unsuspend

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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."
}

Request   

POST api/v3/admin/orders/{id}/service/terminate

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 1

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."
}

Request   

GET api/v3/admin/orders/{id}/provisioning-logs

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the order. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: date_string, level. Example: date_string

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: message. Example: message

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\": \"terminate\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/orders/actions/list'
payload = {
    "type": "Server",
    "action": "terminate"
}
params = {
  'type': 'Server',
  'action': 'activate',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload, params=params)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/orders/actions/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'type' => 'Server',
            'action' => 'activate',
        ],
        'json' => [
            'type' => 'Server',
            'action' => 'terminate',
        ],
    ]
);
$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."
}

Request   

GET api/v3/admin/orders/actions/list

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

type   string     

The module type. Allowed: Server, Colocation. Example: Server

action   string     

The order action. Allowed: activate, suspend, unsuspend, terminate. Example: activate

Body Parameters

type   string     

Example: Server

Must be one of:
  • Server
  • Colocation
action   string     

Example: terminate

Must be one of:
  • activate
  • suspend
  • unsuspend
  • terminate

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."
}

Request   

POST api/v3/admin/orders/stock

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

criteria   object     

Criteria for searching the devices in stock. Can include model, location, parts, metadata, etc.

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": 98,
            "name": "Samir Yundt",
            "order": 6,
            "parent_id": 1682,
            "child_id": 1681,
            "created_at": "2025-11-12 09:09:40",
            "updated_at": "2025-11-12 09:09:40"
        },
        {
            "id": 99,
            "name": "Miss Daniela Nienow",
            "order": 4,
            "parent_id": 1684,
            "child_id": 1683,
            "created_at": "2025-11-12 09:09:42",
            "updated_at": "2025-11-12 09:09:42"
        }
    ],
    "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."
}

Request   

GET api/v3/admin/device-bays

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, parent_id, child_id, name. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, parent_id, child_id, name. Example: id

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": 100,
        "name": "Easter Steuber",
        "order": 0,
        "parent": {
            "id": 1686,
            "label": "commodi",
            "model": "illum",
            "product_id": 0,
            "model_id": 2499,
            "parent_id": 0,
            "type_id": 6,
            "user_id": 9630,
            "order_id": 0,
            "location_id": 5458,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Crona LLC",
            "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=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        },
        "child": null,
        "created_at": "2025-11-12 09:09:44",
        "updated_at": "2025-11-12 09:09:44"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/device-bays/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device bay. Example: 1

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": 101,
        "name": "Adell Orn",
        "order": 6,
        "parent": {
            "id": 1688,
            "label": "reprehenderit",
            "model": "molestias",
            "product_id": 0,
            "model_id": 2503,
            "parent_id": 0,
            "type_id": 6,
            "user_id": 9636,
            "order_id": 0,
            "location_id": 5462,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Raynor Inc",
            "metadata": [],
            "locked": 0,
            "last_discovered": "Never",
            "discovery_time": 0,
            "last_polled": "Never",
            "poller_disabled": 0,
            "poller_time": 0,
            "last_hour_traffic": 0,
            "last_day_traffic": 0,
            "last_week_traffic": 0,
            "last_month_traffic": 0,
            "current_month_traffic": 0,
            "labeledRackWithPosition": "<span class=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        },
        "child": {
            "id": 1687,
            "label": "reiciendis",
            "model": "provident",
            "product_id": 0,
            "model_id": 2501,
            "parent_id": 0,
            "type_id": 3014,
            "user_id": 9633,
            "order_id": 0,
            "location_id": 5462,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Raynor Inc",
            "metadata": [],
            "locked": 0,
            "last_discovered": "Never",
            "discovery_time": 0,
            "last_polled": "Never",
            "poller_disabled": 0,
            "poller_time": 0,
            "last_hour_traffic": 0,
            "last_day_traffic": 0,
            "last_week_traffic": 0,
            "last_month_traffic": 0,
            "current_month_traffic": 0,
            "labeledRackWithPosition": "<span class=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        },
        "created_at": "2025-11-12 09:09:45",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/device-bays

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The name of the device bay. Example: First Device Bay

parent_id   integer     

Parent Id of device bay. Must be device id of Blade type device. The id of an existing record in the items table. Example: 10

child_id   integer     

Child Id of device bay. Must be device id of size 0 device. The id of an existing record in the items table. Example: 18

order   integer  optional    

The order of the device bay. Example: 1

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": 102,
        "name": "Broderick Gulgowski I",
        "order": 1,
        "parent": {
            "id": 1690,
            "label": "odit",
            "model": "accusantium",
            "product_id": 0,
            "model_id": 2507,
            "parent_id": 0,
            "type_id": 6,
            "user_id": 9642,
            "order_id": 0,
            "location_id": 5466,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Buckridge Ltd",
            "metadata": [],
            "locked": 0,
            "last_discovered": "Never",
            "discovery_time": 0,
            "last_polled": "Never",
            "poller_disabled": 0,
            "poller_time": 0,
            "last_hour_traffic": 0,
            "last_day_traffic": 0,
            "last_week_traffic": 0,
            "last_month_traffic": 0,
            "current_month_traffic": 0,
            "labeledRackWithPosition": "<span class=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        },
        "child": null,
        "created_at": "2025-11-12 09:09:47",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

PUT api/v3/admin/device-bays/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device bay. Example: 1

Body Parameters

name   string  optional    

The name of the device bay. Example: First Device Bay

child_id   integer  optional    

Child Id of device bay. Must be device id of size 0 device. The id of an existing record in the items table. Example: 18

order   integer  optional    

The order of the device bay. Example: 1

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."
}

Request   

DELETE api/v3/admin/device-bays/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device bay. Example: 5

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": 3020,
            "name": "quisquam",
            "description": "Eveniet velit dolor nihil dolor.",
            "hardware": 0,
            "software": 1,
            "predefined": 1,
            "color": "navy",
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09:47"
        },
        {
            "id": 3021,
            "name": "et",
            "description": "Similique placeat omnis quaerat neque consequatur.",
            "hardware": 0,
            "software": 0,
            "predefined": 1,
            "color": "silver",
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09:47"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/types

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, predefined. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, description. Example: id

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": 3022,
        "name": "repudiandae",
        "description": "Commodi a totam numquam est temporibus quisquam.",
        "hardware": 1,
        "software": 0,
        "predefined": 1,
        "color": "gray",
        "created_at": "2025-11-12 09:09:47",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

GET api/v3/admin/types/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type. Example: 1

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": 3023,
        "name": "eum",
        "description": "Iste sit eligendi nesciunt tempore sed neque.",
        "hardware": 1,
        "software": 1,
        "predefined": 1,
        "color": "white",
        "created_at": "2025-11-12 09:09:47",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

POST api/v3/admin/types

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The name of the item type. Example: Blade

description   string  optional    

The description of the item type. Example: Blade type description

group   string  optional    

The group of the type. Example: hardware

Must be one of:
  • hardware
  • software
color   string  optional    

The color of the item type. Example: #A8DBA8

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": 3024,
        "name": "et",
        "description": "Est occaecati voluptas nam omnis qui architecto quia.",
        "hardware": 0,
        "software": 1,
        "predefined": 0,
        "color": "lime",
        "created_at": "2025-11-12 09:09:47",
        "updated_at": "2025-11-12 09:09: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."
}

Request   

PUT api/v3/admin/types/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type. Example: 1

Body Parameters

name   string  optional    

The name of the item type. Example: Blade

description   string  optional    

The description of the item type. Example: Blade type description

group   string  optional    

The group of the type. Example: hardware

Must be one of:
  • hardware
  • software
color   string  optional    

The color of the item type. Example: #A8DBA8

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."
}

Request   

DELETE api/v3/admin/types/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type. Example: 5

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": 99,
            "title": "Angie Von MD"
        },
        {
            "id": 100,
            "title": "Royal Harvey"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/groups

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, title. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, title. Example: id

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": 484,
            "name": "illo.ea.in",
            "display_name": "Gregg Mann Jr.",
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09:47"
        },
        {
            "id": 485,
            "name": "sed.quos.eum",
            "display_name": "Lea Zieme",
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09: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."
}

Request   

GET api/v3/admin/permissions

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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": 101,
        "title": "Eloise Reynolds IV",
        "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."
}

Request   

GET api/v3/admin/groups/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the group. Example: 1

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": 102,
        "title": "Lorenzo Ebert",
        "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."
}

Request   

POST api/v3/admin/groups

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

title   string     

The name of the group. Example: Employees

permissions   integer[]  optional    

Array of permissions ids. The id of an existing record in the permissions table.

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": 103,
        "title": "Dr. Ben Blick",
        "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."
}

Request   

PUT api/v3/admin/groups/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the group. Example: 1

Body Parameters

title   string  optional    

The name of the group. Example: Employees

permissions   integer[]  optional    

Array of permissions ids. The id of an existing record in the permissions table.

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."
}

Request   

DELETE api/v3/admin/groups/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the group. Example: 5

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": 1691,
            "model_id": 2509,
            "parent_id": 0,
            "type_id": 3025,
            "user_id": 9645,
            "location_id": 5468,
            "rack_id": 0,
            "position": null,
            "image": null,
            "is_part": 1,
            "mountable": 0,
            "model": "rerum",
            "manufacturer": "Toy, Quigley and Quigley",
            "serialnumber1": "SN174LJ",
            "serialnumber2": null,
            "service_tag": "ST910GA",
            "comments": null,
            "label": "et",
            "description": "Repellat laborum cupiditate enim.",
            "purchase_date": "2024-11-12",
            "warranty_months": 24,
            "warranty_info": null,
            "status": "available",
            "function": null,
            "origin": null,
            "buy_price": 0,
            "appdata": false,
            "notes": null,
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09:47"
        },
        {
            "id": 1692,
            "model_id": 2511,
            "parent_id": 0,
            "type_id": 3027,
            "user_id": 9648,
            "location_id": 5470,
            "rack_id": 0,
            "position": null,
            "image": null,
            "is_part": 1,
            "mountable": 0,
            "model": "eos",
            "manufacturer": "Stiedemann-Renner",
            "serialnumber1": "SN591ZH",
            "serialnumber2": null,
            "service_tag": "ST948YR",
            "comments": null,
            "label": "nobis",
            "description": "Perferendis sed qui aut et.",
            "purchase_date": "2024-11-12",
            "warranty_months": 24,
            "warranty_info": null,
            "status": "available",
            "function": null,
            "origin": null,
            "buy_price": 0,
            "appdata": false,
            "notes": null,
            "created_at": "2025-11-12 09:09:47",
            "updated_at": "2025-11-12 09:09:47"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/items

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, model_id, parent_id, type_id, user_id, location_id, label, description. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, model_id, parent_id, type_id, user_id, location_id, label, description. Example: id

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": 1693,
        "model": {
            "id": 2513,
            "name": "dolore",
            "label": null,
            "type_id": 3029,
            "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": "2025-11-12T08:09:49.000000Z",
            "updated_at": "2025-11-12T08:09:49.000000Z"
        },
        "user": {
            "id": 9651,
            "username": "ntillman",
            "email": "[email protected]",
            "name": "Laverna Hauck",
            "firstname": "Laverna",
            "lastname": "Hauck",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/1ed228a01f2669ff609d036229db1fa5?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/1ed228a01f2669ff609d036229db1fa5?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": 3029,
            "name": "perferendis",
            "description": "Eum rem voluptas quo id velit et vel.",
            "hardware": 1,
            "software": 1,
            "predefined": 0,
            "color": "maroon",
            "created_at": "2025-11-12 09:09:48",
            "updated_at": "2025-11-12 09:09:48"
        },
        "parent": null,
        "location": {
            "id": 5472,
            "app_id": null,
            "name": "Glover-Gleichner",
            "address": "7627 Eino Shore Apt. 801\nNew Delilah, ME 59797",
            "city": "Theronchester",
            "state": "New Jersey",
            "description": "Qui reiciendis molestias similique dolores maiores. Voluptas ut molestiae ut explicabo et placeat occaecati totam. Nihil quia nesciunt et tempore voluptas.",
            "notes": "Perferendis modi rerum odio voluptas sit maxime. Modi quidem ea a ad aliquid. Et non ipsum facere.",
            "emergency": "0",
            "phone": "1-580-912-5873",
            "flag": "Germany.png",
            "created_at": "2025-11-12 09:09:49",
            "updated_at": "2025-11-12 09:09:49"
        },
        "rack": null,
        "metadata": [],
        "position": null,
        "image": null,
        "is_part": 0,
        "mountable": 1,
        "manufacturer": "Schaefer Group",
        "serialnumber1": "SN789LM",
        "serialnumber2": null,
        "service_tag": "ST908FT",
        "comments": null,
        "label": "voluptatum",
        "description": "Similique et voluptatem voluptatibus non cumque recusandae sunt.",
        "purchase_date": "2024-11-12",
        "warranty_months": 24,
        "warranty_info": null,
        "status": "available",
        "function": null,
        "origin": null,
        "buy_price": 0,
        "appdata": false,
        "notes": null,
        "created_at": "2025-11-12 09:09:48",
        "updated_at": "2025-11-12 09:09:48"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/items/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item. Example: 1

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."
}

Request   

GET api/v3/admin/items/{id}/qrcode

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item. Example: 1

Query Parameters

size   integer  optional    

The size of the QR code. Example: 300

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\": false,
    \"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": false,
    "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' => false,
            '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": 1694,
        "model": {
            "id": 2515,
            "name": "dolores",
            "label": null,
            "type_id": 3031,
            "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": "2025-11-12T08:09:50.000000Z",
            "updated_at": "2025-11-12T08:09:50.000000Z"
        },
        "user": {
            "id": 9654,
            "username": "wehner.hadley",
            "email": "[email protected]",
            "name": "Salvador Considine",
            "firstname": "Salvador",
            "lastname": "Considine",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/bef541ac7fc1050fb5c4b9624bc078f6?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/bef541ac7fc1050fb5c4b9624bc078f6?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": 3031,
            "name": "eos",
            "description": "Provident odio non qui officiis corporis laboriosam minima velit.",
            "hardware": 1,
            "software": 0,
            "predefined": 0,
            "color": "green",
            "created_at": "2025-11-12 09:09:49",
            "updated_at": "2025-11-12 09:09:49"
        },
        "parent": null,
        "location": {
            "id": 5474,
            "app_id": null,
            "name": "Durgan-Effertz",
            "address": "80911 Bertrand Ville Apt. 646\nNew Beatricefurt, TX 74083",
            "city": "Ezekielbury",
            "state": "Ohio",
            "description": "Dicta aut qui fugit saepe. Autem ut distinctio voluptatem et cumque. Ut voluptatem aut id consequatur et. A eum nihil ut explicabo.",
            "notes": "Esse iste quas molestiae qui error quis. Dignissimos libero ut quisquam mollitia. Sit aspernatur molestiae voluptatem. Libero doloribus ducimus corporis ut quia rerum ut.",
            "emergency": "1",
            "phone": "+1-586-730-3517",
            "flag": "Canada.png",
            "created_at": "2025-11-12 09:09:50",
            "updated_at": "2025-11-12 09:09:50"
        },
        "rack": null,
        "metadata": [],
        "position": null,
        "image": null,
        "is_part": 1,
        "mountable": 0,
        "manufacturer": "Emard-Hessel",
        "serialnumber1": "SN955JX",
        "serialnumber2": null,
        "service_tag": "ST310PV",
        "comments": null,
        "label": "natus",
        "description": "Officia quia ea et iure aut pariatur magnam.",
        "purchase_date": "2024-11-12",
        "warranty_months": 24,
        "warranty_info": null,
        "status": "available",
        "function": null,
        "origin": null,
        "buy_price": 0,
        "appdata": false,
        "notes": null,
        "created_at": "2025-11-12 09:09:49",
        "updated_at": "2025-11-12 09:09:49"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/items

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

label   string     

The name of the item. Example: Intel Xeon

model   string     

The model ID of the item, or a custom string for new models. Example: 123

type_id   integer     

The type ID of the item. The id of an existing record in the item_types table. Example: 1

user_id   integer  optional    

The user ID assigned to the item. The id of an existing record in the users table. Example: 5

parent_id   integer  optional    

The parent item ID, if this item is mountable. The id of an existing record in the items table. Example: 10

location_id   integer  optional    

The location ID where the item is stored. The id of an existing record in the locations table. Example: 3

is_part   boolean  optional    

Determine if this item is part. Example: false

manufacturer   string  optional    

The manufacturer of the item. Example: Intel

serialnumber1   string  optional    

Primary serial number of the item. Example: SN123456789

service_tag   string  optional    

Unique service tag or identifier of the item. Example: ST987654

comments   string  optional    

Any additional comments about the item. Example: Example comment

description   string  optional    

Detailed description of the item. Example: Intel Xeon server CPU with 8 cores

purchase_date   string  optional    

The purchase date of the item. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-17

warranty_months   integer  optional    

Warranty period in months. Example: 36

warranty_info   string  optional    

Additional warranty information. Example: Standard 3-year warranty

status   string  optional    

Current status of the item. Example: available

Must be one of:
  • available
  • bought
  • defect
  • in use
  • not_delivered
  • sold
  • repair
  • not_set
function   string  optional    

The function or role of the item. Example: Server CPU

origin   string  optional    

The origin or source of the item. Example: Warehouse A

buy_price   number  optional    

Purchase price of the item. Example: 2500.5

appdata   object  optional    

Additional application-specific data for the item.

notes   string  optional    

Additional notes about the item. Example: Needs firmware update

metadata   object[]     
metadata_id   integer     

The ID of the metadata type. The id of an existing record in the types_fields table. Example: 37

value   string     

The value of the metadata entry. Example: 1

raw_value   string  optional    

Optional raw value for the metadata entry. Example: 1

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\": false,
    \"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": false,
    "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' => false,
            '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": 1695,
        "model": {
            "id": 2517,
            "name": "totam",
            "label": null,
            "type_id": 3033,
            "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": "2025-11-12T08:09:51.000000Z",
            "updated_at": "2025-11-12T08:09:51.000000Z"
        },
        "user": {
            "id": 9657,
            "username": "kristin.medhurst",
            "email": "[email protected]",
            "name": "Marilie Abernathy",
            "firstname": "Marilie",
            "lastname": "Abernathy",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/5e255d7091ef474cd8ed41bcb549d5d3?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/5e255d7091ef474cd8ed41bcb549d5d3?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": 3033,
            "name": "commodi",
            "description": "Illo corporis alias voluptas voluptatem autem necessitatibus.",
            "hardware": 1,
            "software": 0,
            "predefined": 0,
            "color": "maroon",
            "created_at": "2025-11-12 09:09:50",
            "updated_at": "2025-11-12 09:09:50"
        },
        "parent": null,
        "location": {
            "id": 5476,
            "app_id": null,
            "name": "Jakubowski LLC",
            "address": "314 Oren Stravenue\nElvieshire, IA 43384-5044",
            "city": "Bartellshire",
            "state": "New York",
            "description": "Qui voluptatem cumque sit qui aliquid beatae voluptatem. Necessitatibus aspernatur adipisci assumenda quam qui ducimus. Id asperiores libero modi ipsum reiciendis. In officia voluptas deleniti fugit possimus consectetur labore accusantium.",
            "notes": "Quo eos eveniet ut sed porro enim. Ipsa a recusandae in dolores cum. Id optio alias rerum earum harum nam. Ut ipsum quisquam atque optio facilis facere sunt.",
            "emergency": "0",
            "phone": "+1 (832) 699-8895",
            "flag": "USA.png",
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        },
        "rack": null,
        "metadata": [],
        "position": null,
        "image": null,
        "is_part": 1,
        "mountable": 0,
        "manufacturer": "Lowe PLC",
        "serialnumber1": "SN591EF",
        "serialnumber2": null,
        "service_tag": "ST453NP",
        "comments": null,
        "label": "molestiae",
        "description": "Illo modi ad quis.",
        "purchase_date": "2024-11-12",
        "warranty_months": 24,
        "warranty_info": null,
        "status": "available",
        "function": null,
        "origin": null,
        "buy_price": 0,
        "appdata": false,
        "notes": null,
        "created_at": "2025-11-12 09:09:50",
        "updated_at": "2025-11-12 09:09:50"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/items/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item. Example: 1

Body Parameters

label   string  optional    

The name of the item. Example: Intel Xeon

model   integer  optional    

The model ID of the item. Example: 123

user_id   integer  optional    

The user ID assigned to the item. The id of an existing record in the users table. Example: 5

parent_id   integer  optional    

The parent item ID, if this item is mountable. The id of an existing record in the items table. Example: 10

location_id   integer  optional    

The location ID where the item is stored. The id of an existing record in the locations table. Example: 3

is_part   boolean  optional    

Determine if this item is part. Example: false

manufacturer   string  optional    

The manufacturer of the item. Example: Intel

serialnumber1   string  optional    

Primary serial number of the item. Example: SN123456789

service_tag   string  optional    

Unique service tag or identifier of the item. Example: ST987654

comments   string  optional    

Any additional comments about the item. Example: Example comment

description   string  optional    

Detailed description of the item. Example: Intel Xeon server CPU with 8 cores

purchase_date   string  optional    

The purchase date of the item. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-17

warranty_months   integer  optional    

Warranty period in months. Example: 36

warranty_info   string  optional    

Additional warranty information. Example: Standard 3-year warranty

status   string  optional    

Current status of the item. Example: available

Must be one of:
  • available
  • bought
  • defect
  • in use
  • not_delivered
  • sold
  • repair
  • not_set
function   string  optional    

The function or role of the item. Example: Server CPU

origin   string  optional    

The origin or source of the item. Example: Warehouse A

buy_price   number  optional    

Purchase price of the item. Example: 2500.5

appdata   object  optional    

Additional application-specific data for the item.

notes   string  optional    

Additional notes about the item. Example: Needs firmware update

metadata   object[]     
metadata_id   integer     

The ID of the metadata type. The id of an existing record in the types_fields table. Example: 37

value   string     

The value of the metadata entry. Example: 1

raw_value   string  optional    

Optional raw value for the metadata entry. Example: 1

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": 1696,
        "model": {
            "id": 2519,
            "name": "et",
            "label": null,
            "type_id": 3035,
            "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": "2025-11-12T08:09:51.000000Z",
            "updated_at": "2025-11-12T08:09:51.000000Z"
        },
        "user": {
            "id": 9660,
            "username": "annabel.krajcik",
            "email": "[email protected]",
            "name": "Enos Graham",
            "firstname": "Enos",
            "lastname": "Graham",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/da3b8cfeafec9929f55bd6a9c8de10c1?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/da3b8cfeafec9929f55bd6a9c8de10c1?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": 3035,
            "name": "quia",
            "description": "Non assumenda sunt iure ipsa.",
            "hardware": 1,
            "software": 1,
            "predefined": 1,
            "color": "teal",
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        },
        "parent": null,
        "location": {
            "id": 5478,
            "app_id": null,
            "name": "Miller, Schaefer and Nikolaus",
            "address": "94692 Josiah Estate\nRebekahport, WA 14806",
            "city": "West Aubrey",
            "state": "California",
            "description": "Pariatur minus sed voluptas sint iusto sunt omnis earum. Voluptates voluptatem esse magni exercitationem quia consequatur excepturi. Corporis et aut laborum officia.",
            "notes": "Fugit unde ut et asperiores magnam. Cupiditate est ut culpa omnis. Omnis recusandae vel veritatis quis. Ut vel natus sint. Rem qui officiis iusto dolor illo.",
            "emergency": "0",
            "phone": "+1.252.675.4274",
            "flag": "USA.png",
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        },
        "rack": null,
        "metadata": [],
        "position": null,
        "image": null,
        "is_part": 0,
        "mountable": 1,
        "manufacturer": "Ernser-Shields",
        "serialnumber1": "SN930ZX",
        "serialnumber2": null,
        "service_tag": "ST198XL",
        "comments": null,
        "label": "provident",
        "description": "Error fugiat dolores ut sunt accusamus quisquam.",
        "purchase_date": "2024-11-12",
        "warranty_months": 24,
        "warranty_info": null,
        "status": "available",
        "function": null,
        "origin": null,
        "buy_price": 0,
        "appdata": false,
        "notes": null,
        "created_at": "2025-11-12 09:09:51",
        "updated_at": "2025-11-12 09:09:51"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/items/{id}/metadata/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item. Example: 1

Body Parameters

slug   string     

The slug of the item metadata field. The slug of an existing record in the types_fields table. Example: ipmi.ip

value   string     

The value for the item metadata field. Example: 192.168.56.180

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."
}

Request   

DELETE api/v3/admin/items/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item. Example: 5

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": 210,
            "related_type": null,
            "element": "text",
            "group": "Base",
            "slug": "dolore.fugit.et",
            "label": "Mrs. Felicia Ankunding I",
            "options": {
                "tempora ab cupiditate quo quisquam": "tempora ab cupiditate quo quisquam"
            },
            "predefined": 0,
            "hidden": 0,
            "provisionable": 1,
            "combined": 0,
            "filterable": 0,
            "filterable_type": null,
            "unique": 0,
            "sortable": 0,
            "encrypted": 1,
            "additional_rules": [
                "at",
                "facilis",
                "doloremque",
                "sunt",
                "facere"
            ],
            "order": 48,
            "types": [],
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        },
        {
            "id": 211,
            "related_type": null,
            "element": "text",
            "group": "Base",
            "slug": "quia.eius.officia",
            "label": "Jarrett Cormier",
            "options": {
                "et veniam sequi commodi quidem": "et veniam sequi commodi quidem"
            },
            "predefined": 0,
            "hidden": 1,
            "provisionable": 0,
            "combined": 0,
            "filterable": 0,
            "filterable_type": null,
            "unique": 0,
            "sortable": 0,
            "encrypted": 1,
            "additional_rules": [
                "ut",
                "est",
                "sunt",
                "dolor",
                "corporis"
            ],
            "order": 98,
            "types": [],
            "created_at": "2025-11-12 09:09:51",
            "updated_at": "2025-11-12 09:09:51"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/fields

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, slug, predefined, label, unique. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, slug, predefined, label, unique. Example: id

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": 212,
        "related_type": null,
        "element": "text",
        "group": "Base",
        "slug": "placeat.est.nobis",
        "label": "Marian Treutel",
        "options": {
            "quibusdam quam molestias architecto amet": "quibusdam quam molestias architecto amet"
        },
        "predefined": 1,
        "hidden": 1,
        "provisionable": 1,
        "combined": 0,
        "filterable": 0,
        "filterable_type": null,
        "unique": 1,
        "sortable": 1,
        "encrypted": 1,
        "additional_rules": [
            "quasi",
            "eligendi",
            "quia",
            "aliquam",
            "autem"
        ],
        "order": 81,
        "values": [],
        "types": [],
        "created_at": "2025-11-12 09:09:51",
        "updated_at": "2025-11-12 09:09:51"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/fields/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type field. Example: 1

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\": false,
    \"combined\": false,
    \"filterable\": false,
    \"filterable_type\": \"equals\",
    \"unique\": false,
    \"sortable\": false,
    \"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": false,
    "combined": false,
    "filterable": false,
    "filterable_type": "equals",
    "unique": false,
    "sortable": false,
    "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' => false,
            'combined' => false,
            'filterable' => false,
            'filterable_type' => 'equals',
            'unique' => false,
            'sortable' => false,
            '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": 213,
        "related_type": null,
        "element": "text",
        "group": "Base",
        "slug": "assumenda.voluptas.dolore",
        "label": "Mrs. Liana Kemmer",
        "options": {
            "sint id molestiae ut voluptatem": "sint id molestiae ut voluptatem"
        },
        "predefined": 1,
        "hidden": 1,
        "provisionable": 1,
        "combined": 0,
        "filterable": 0,
        "filterable_type": null,
        "unique": 1,
        "sortable": 1,
        "encrypted": 1,
        "additional_rules": [
            "corrupti",
            "est",
            "tempora",
            "recusandae",
            "porro"
        ],
        "order": 46,
        "values": [],
        "types": [],
        "created_at": "2025-11-12 09:09:51",
        "updated_at": "2025-11-12 09:09:51"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/fields

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

element   string     

The type of element. Example: text

Must be one of:
  • text
  • dropdown
  • textarea
group   string  optional    

The group this field belongs to. Can be "Base", "System", "IPMI Additional Settings", "SSH Settings", or a custom group. Must not be greater than 255 characters. Example: Base

slug   string     

Unique identifier for the field. Must not be greater than 255 characters. Example: hostname

label   string     

Human-readable label for the field. Must not be greater than 255 characters. Example: Host Name

options   string  optional    

Comma seperated optional list for dropdown element type. Example: option1,option2

hidden   boolean  optional    

Determines if the field is hidden. Example: false

provisionable   boolean  optional    

Determines if the field is provisionable. Example: false

combined   boolean  optional    

Determines if the field is combined. Example: false

filterable   boolean  optional    

Determines if the field is filterable. Example: false

filterable_type   string  optional    

Type of filter. This field is required when filterable is 1. Example: equals

unique   boolean  optional    

Determines if the field value must be unique. Example: false

sortable   boolean  optional    

Determines if the field is sortable. Example: false

encrypted   boolean  optional    

Determines if the field value will be stored encrypted. Example: false

additional_rules   object  optional    

Additional rules for the field.

order   integer  optional    

Position of the field in the list. Must be at least 0. Example: 1

types   integer[]  optional    

List of related item type IDs. The id of an existing record in the item_types table.

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\": false,
    \"combined\": false,
    \"filterable\": false,
    \"filterable_type\": \"equals\",
    \"unique\": false,
    \"sortable\": false,
    \"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": false,
    "combined": false,
    "filterable": false,
    "filterable_type": "equals",
    "unique": false,
    "sortable": false,
    "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' => false,
            'combined' => false,
            'filterable' => false,
            'filterable_type' => 'equals',
            'unique' => false,
            'sortable' => false,
            '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": 214,
        "related_type": null,
        "element": "dropdown",
        "group": "Base",
        "slug": "at.iure.consequatur",
        "label": "Alba Littel V",
        "options": {
            "dolor et eos autem ipsum": "dolor et eos autem ipsum"
        },
        "predefined": 1,
        "hidden": 0,
        "provisionable": 1,
        "combined": 0,
        "filterable": 0,
        "filterable_type": null,
        "unique": 0,
        "sortable": 1,
        "encrypted": 1,
        "additional_rules": [
            "commodi",
            "quia",
            "esse",
            "ratione",
            "nihil"
        ],
        "order": 61,
        "values": [],
        "types": [],
        "created_at": "2025-11-12 09:09:51",
        "updated_at": "2025-11-12 09:09:51"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/fields/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type field. Example: 1

Body Parameters

element   string  optional    

The type of element. Example: text

Must be one of:
  • text
  • dropdown
  • textarea
group   string  optional    

The group this field belongs to. Can be "Base", "System", "IPMI Additional Settings", "SSH Settings", or a custom group. Must not be greater than 255 characters. Example: Base

slug   string  optional    

Unique identifier for the field. Must not be greater than 255 characters. Example: hostname

label   string  optional    

Human-readable label for the field. Must not be greater than 255 characters. Example: Host Name

options   string  optional    

Comma seperated optional list for dropdown element type. Example: option1,option2

hidden   boolean  optional    

Determines if the field is hidden. Example: false

provisionable   boolean  optional    

Determines if the field is provisionable. Example: false

combined   boolean  optional    

Determines if the field is combined. Example: false

filterable   boolean  optional    

Determines if the field is filterable. Example: false

filterable_type   string  optional    

Type of filter. This field is required when filterable is 1. Example: equals

unique   boolean  optional    

Determines if the field value must be unique. Example: false

sortable   boolean  optional    

Determines if the field is sortable. Example: false

encrypted   boolean  optional    

Determines if the field value will be stored encrypted. Example: false

additional_rules   object  optional    

Additional rules for the field.

order   integer  optional    

Position of the field in the list. Must be at least 0. Example: 1

types   integer[]  optional    

List of related item type IDs. The id of an existing record in the item_types table.

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."
}

Request   

DELETE api/v3/admin/fields/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the item type field. Example: 5

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": 370,
            "item_id": 1704,
            "name": "ratione",
            "class": "Power Supply",
            "type": "Thermal",
            "unit": "Celsius",
            "index": "Thermal",
            "reading": 669,
            "last_polled": "0000-00-00 00:00:00",
            "configuration": [],
            "created_at": "2025-11-12 09:10:03",
            "updated_at": "2025-11-12 09:10:03"
        },
        {
            "id": 371,
            "item_id": 1705,
            "name": "eius",
            "class": "Fans",
            "type": "Power",
            "unit": "Voltages",
            "index": "Power",
            "reading": 462,
            "last_polled": "0000-00-00 00:00:00",
            "configuration": [],
            "created_at": "2025-11-12 09:10:04",
            "updated_at": "2025-11-12 09:10:04"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/sensors

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, name, class, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, item_id, name, class, type. Example: id

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": 372,
        "item_id": 1706,
        "name": "et",
        "class": "Power Supply",
        "type": "Thermal",
        "unit": "RPM",
        "index": "Thermal",
        "reading": 556,
        "last_polled": "0000-00-00 00:00:00",
        "configuration": [],
        "created_at": "2025-11-12 09:10:05",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

GET api/v3/admin/sensors/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the sensor. Example: 1

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."
}

Request   

DELETE api/v3/admin/sensors/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the sensor. Example: 5

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": 82,
            "name": "eum",
            "type": "Server",
            "default": 1,
            "value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:5:\"label\";i:1;s:5:\"model\";i:2;s:8:\"position\";i:3;s:11:\"description\";i:4;s:8:\"location\";}s:18:\"traffic_statistics\";a:5:{i:0;s:23:\"widget_last_month_graph\";i:1;s:17:\"left_sidebar_link\";i:2;s:9:\"filtering\";i:3;s:17:\"widget_last_month\";i:4;s:20:\"widget_network_ports\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:20:\"widget_average_usage\";i:2;s:9:\"filtering\";i:3;s:23:\"widget_last_month_graph\";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:11:\"create_rdns\";i:2;s:11:\"delete_rdns\";i:3;s:22:\"rdns_left_sidebar_link\";}}"
        },
        {
            "id": 83,
            "name": "in",
            "type": "Colocation",
            "default": 0,
            "value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:5:\"model\";i:1;s:8:\"location\";i:2;s:11:\"description\";i:3;s:5:\"label\";i:4;s:8:\"position\";}s:18:\"traffic_statistics\";a:5:{i:0;s:17:\"left_sidebar_link\";i:1;s:17:\"widget_last_month\";i:2;s:20:\"widget_network_ports\";i:3;s:9:\"filtering\";i:4;s:23:\"widget_last_month_graph\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:23:\"widget_last_month_graph\";i:2;s:9:\"filtering\";i:3;s:20:\"widget_average_usage\";i:4;s:7:\"outlets\";i:5;s:17:\"left_sidebar_link\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"update_rdns\";i:1;s:11:\"delete_rdns\";i:2;s:22:\"rdns_left_sidebar_link\";i:3;s:11:\"create_rdns\";}}"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/service-access-levels

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, type. Example: id

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": 1707,
            "label": "laborum",
            "model": "qui",
            "product_id": 0,
            "model_id": 2541,
            "parent_id": 0,
            "type_id": 3057,
            "user_id": 9721,
            "order_id": 1078,
            "location_id": 5514,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Hirthe-Fay",
            "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=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        },
        {
            "id": 1708,
            "label": "unde",
            "model": "quos",
            "product_id": 0,
            "model_id": 2543,
            "parent_id": 0,
            "type_id": 3059,
            "user_id": 9728,
            "order_id": 1079,
            "location_id": 5518,
            "rack_id": 0,
            "blade_id": 0,
            "os_installation": 0,
            "colocation_id": 0,
            "provisioning_id": 0,
            "device_status": "running",
            "service_status": "activated",
            "location": "Labadie-Krajcik",
            "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=\"text-muted\">Unassigned</span>",
            "device_traffic": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/devices

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, model_id, parent_id, colocation_id, type_id, user_id, location_id, label, description, metadata. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, model_id, parent_id, colocation_id, type_id, user_id, location_id, label, description, metadata. Example: id

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": 1709,
        "product_id": 0,
        "model_id": 2545,
        "parent_id": 0,
        "type_id": 3061,
        "user_id": 9735,
        "order_id": 1080,
        "location_id": 5522,
        "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": "Adams Ltd",
        "serialnumber1": "SN736TT",
        "serialnumber2": null,
        "service_tag": "ST602DD",
        "comments": null,
        "label": "deserunt",
        "description": "Modi quia facilis id aliquid.",
        "purchase_date": "2024-11-12",
        "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=\"text-muted\">Unassigned</span>",
        "metadata": [],
        "device_traffic": null,
        "type": {
            "id": 3061,
            "name": "voluptas",
            "description": "Et pariatur expedita et culpa reprehenderit amet assumenda.",
            "hardware": 1,
            "software": 1,
            "predefined": 0,
            "color": "teal",
            "created_at": "2025-11-12 09:10:07",
            "updated_at": "2025-11-12 09:10:07"
        },
        "model": {
            "id": 2545,
            "name": "est",
            "label": null,
            "type_id": 3061,
            "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": "2025-11-12T08:10:09.000000Z",
            "updated_at": "2025-11-12T08:10:09.000000Z"
        },
        "user": {
            "id": 9735,
            "username": "naomi89",
            "email": "[email protected]",
            "name": "Patience Gutkowski",
            "firstname": "Patience",
            "lastname": "Gutkowski",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/73e0bf1eadfca441762f1f4d4910c48d?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/73e0bf1eadfca441762f1f4d4910c48d?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": 5522,
            "app_id": null,
            "name": "Crooks Inc",
            "address": "663 Schultz Village\nGabefort, VA 09519",
            "city": "East Emileshire",
            "state": "North Dakota",
            "description": "Quo dolore repellat sed sunt eaque eaque nisi voluptates. Illum consequatur eius et est sed vitae quod. Consequatur cupiditate deleniti vel ea distinctio. Impedit perferendis molestias ullam omnis tenetur velit ipsa totam.",
            "notes": "Officiis et repellat non molestias ex natus. Eos voluptas sed eveniet et est cum occaecati odio. Accusantium optio deserunt itaque dicta provident.",
            "emergency": "1",
            "phone": "(872) 239-7315",
            "flag": "Canada.png",
            "created_at": "2025-11-12 09:10:08",
            "updated_at": "2025-11-12 09:10:08"
        },
        "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."
}

Request   

GET api/v3/admin/devices/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

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\": 1,
    \"location\": 6,
    \"client\": 3,
    \"rack\": 11,
    \"position\": 20,
    \"size_position\": \"dignissimos\",
    \"is_part\": false,
    \"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/devices'
payload = {
    "label": "Intel Xeon",
    "model": 123,
    "type_id": 1,
    "parent": 1,
    "location": 6,
    "client": 3,
    "rack": 11,
    "position": 20,
    "size_position": "dignissimos",
    "is_part": false,
    "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/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' => 1,
            'location' => 6,
            'client' => 3,
            'rack' => 11,
            'position' => 20,
            'size_position' => 'dignissimos',
            'is_part' => false,
            '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": 1710,
        "product_id": 0,
        "model_id": 2547,
        "parent_id": 0,
        "type_id": 3063,
        "user_id": 9742,
        "order_id": 1081,
        "location_id": 5526,
        "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": "Mosciski-Bauch",
        "serialnumber1": "SN473KV",
        "serialnumber2": null,
        "service_tag": "ST778DK",
        "comments": null,
        "label": "ipsum",
        "description": "Ipsam neque repellendus aliquid ratione explicabo ut voluptas nam.",
        "purchase_date": "2024-11-12",
        "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=\"text-muted\">Unassigned</span>",
        "metadata": [],
        "device_traffic": null,
        "type": {
            "id": 3063,
            "name": "nam",
            "description": "Nam nihil illo qui.",
            "hardware": 0,
            "software": 0,
            "predefined": 0,
            "color": "fuchsia",
            "created_at": "2025-11-12 09:10:09",
            "updated_at": "2025-11-12 09:10:09"
        },
        "model": {
            "id": 2547,
            "name": "et",
            "label": null,
            "type_id": 3063,
            "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": "2025-11-12T08:10:10.000000Z",
            "updated_at": "2025-11-12T08:10:10.000000Z"
        },
        "user": {
            "id": 9742,
            "username": "aklocko",
            "email": "[email protected]",
            "name": "Brennon Lind",
            "firstname": "Brennon",
            "lastname": "Lind",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/13a1b3a40c53fd35ceb9afa8544a6bf1?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/13a1b3a40c53fd35ceb9afa8544a6bf1?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": 5526,
            "app_id": null,
            "name": "Fritsch-Runolfsdottir",
            "address": "7197 Larkin Field\nNew Raymondchester, LA 43338",
            "city": "Kylaberg",
            "state": "Georgia",
            "description": "Est sit eaque laboriosam. Ea suscipit rerum deserunt impedit minus animi eius. Suscipit deleniti dignissimos quibusdam vitae natus rerum.",
            "notes": "Est dolorem rem quod molestiae minima deleniti. Quis ut reiciendis voluptate iusto. Et optio sed dolores optio. Molestiae est blanditiis consequatur aut laborum deleniti rem.",
            "emergency": "1",
            "phone": "(469) 616-8960",
            "flag": "Germany.png",
            "created_at": "2025-11-12 09:10:09",
            "updated_at": "2025-11-12 09:10:09"
        },
        "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."
}

Request   

POST api/v3/admin/devices

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

label   string     

The name of the device. Example: Intel Xeon

model   string     

The model ID of the device, or a custom string for new models. Example: 123

type_id   integer     

The type ID of the device. The id of an existing record in the item_types table. Example: 1

parent   integer  optional    

The id of an existing record in the items table. Example: 1

location   integer  optional    

The id of an existing record in the locations table. Example: 6

client   integer  optional    

The id of an existing record in the users table. Example: 3

rack   integer  optional    

The id of an existing record in the racks table. Example: 11

position   integer  optional    

Example: 20

size_position   string  optional    

Example: dignissimos

is_part   boolean  optional    

Determine if this device is part. Example: false

manufacturer   string  optional    

The manufacturer of the device. Example: Intel

serialnumber1   string  optional    

Primary serial number of the device. Example: SN123456789

service_tag   string  optional    

Unique service tag or identifier of the device. Example: ST987654

comments   string  optional    

Any additional comments about the device. Example: Example comment

description   string  optional    

Detailed description of the device. Example: Intel Xeon server CPU with 8 cores

purchase_date   string  optional    

The purchase date of the device. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-17

warranty_months   integer  optional    

Warranty period in months. Example: 36

warranty_info   string  optional    

Additional warranty information. Example: Standard 3-year warranty

status   string  optional    

Current status of the device. Example: available

Must be one of:
  • available
  • bought
  • defect
  • in use
  • not_delivered
  • sold
  • repair
  • not_set
function   string  optional    

The function or role of the device. Example: Server CPU

origin   string  optional    

The origin or source of the device. Example: Warehouse A

buy_price   number  optional    

Purchase price of the device. Example: 2500.5

appdata   object  optional    

Additional application-specific data for the device.

notes   string  optional    

Additional notes about the device. Example: Needs firmware update

metadata   object[]     
metadata_id   integer     

The ID of the metadata type. The id of an existing record in the types_fields table. Example: 37

value   string     

The value of the metadata entry. Example: 1

raw_value   string  optional    

Optional raw value for the metadata entry. Example: 1

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\": 3,
    \"position\": 3,
    \"size_position\": \"full\",
    \"is_part\": false,
    \"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/devices/1'
payload = {
    "label": "Intel Xeon",
    "model": 123,
    "parent": 10,
    "location": 3,
    "client": 5,
    "rack": 3,
    "position": 3,
    "size_position": "full",
    "is_part": false,
    "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/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' => 3,
            'position' => 3,
            'size_position' => 'full',
            'is_part' => false,
            '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": 1711,
        "product_id": 0,
        "model_id": 2549,
        "parent_id": 0,
        "type_id": 3065,
        "user_id": 9749,
        "order_id": 1082,
        "location_id": 5530,
        "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": "Schamberger-Will",
        "serialnumber1": "SN316BY",
        "serialnumber2": null,
        "service_tag": "ST252IG",
        "comments": null,
        "label": "inventore",
        "description": "Corporis et provident consectetur deleniti laborum provident nemo vel.",
        "purchase_date": "2024-11-12",
        "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=\"text-muted\">Unassigned</span>",
        "metadata": [],
        "device_traffic": null,
        "type": {
            "id": 3065,
            "name": "quis",
            "description": "Exercitationem animi non quas doloribus aspernatur sed.",
            "hardware": 1,
            "software": 1,
            "predefined": 1,
            "color": "olive",
            "created_at": "2025-11-12 09:10:10",
            "updated_at": "2025-11-12 09:10:10"
        },
        "model": {
            "id": 2549,
            "name": "rerum",
            "label": null,
            "type_id": 3065,
            "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": "2025-11-12T08:10:12.000000Z",
            "updated_at": "2025-11-12T08:10:12.000000Z"
        },
        "user": {
            "id": 9749,
            "username": "nwhite",
            "email": "[email protected]",
            "name": "Sally Bode",
            "firstname": "Sally",
            "lastname": "Bode",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/5b2feba4a1805b52831e0800835d2912?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/5b2feba4a1805b52831e0800835d2912?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": 5530,
            "app_id": null,
            "name": "Wisoky-O'Reilly",
            "address": "28464 Goyette Bridge\nNorth Wava, ND 40347",
            "city": "South Vincenza",
            "state": "South Carolina",
            "description": "Omnis numquam quos reprehenderit et consequatur. Iste nemo voluptatem voluptates ducimus est aperiam voluptatem. Molestiae ullam quasi accusamus voluptatem ipsum.",
            "notes": "Assumenda facere expedita occaecati autem deserunt recusandae est. Aut voluptatem veniam iure consequatur explicabo est quidem. Cumque doloremque consequatur vel.",
            "emergency": "1",
            "phone": "+1-937-583-1753",
            "flag": "Canada.png",
            "created_at": "2025-11-12 09:10:11",
            "updated_at": "2025-11-12 09:10:11"
        },
        "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."
}

Request   

PUT api/v3/admin/devices/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

label   string  optional    

The name of the device. Example: Intel Xeon

model   integer  optional    

The model ID of the device. Example: 123

parent   integer  optional    

The parent device ID, if this device is mountable. The id of an existing record in the items table. Example: 10

location   integer  optional    

The location ID where the device is stored. The id of an existing record in the locations table. Example: 3

client   integer  optional    

The user ID assigned to the device. The id of an existing record in the users table. Example: 5

rack   integer  optional    

The rack ID where the device is stored. The id of an existing record in the racks table. Example: 3

position   integer  optional    

The position in rack for device. Example: 3

size_position   string  optional    

The size position of device. Example: full

is_part   boolean  optional    

Determine if this device is part. Example: false

manufacturer   string  optional    

The manufacturer of the device. Example: Intel

serialnumber1   string  optional    

Primary serial number of the device. Example: SN123456789

service_tag   string  optional    

Unique service tag or identifier of the device. Example: ST987654

comments   string  optional    

Any additional comments about the device. Example: Example comment

description   string  optional    

Detailed description of the device. Example: Intel Xeon server CPU with 8 cores

purchase_date   string  optional    

The purchase date of the device. Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-17

warranty_months   integer  optional    

Warranty period in months. Example: 36

warranty_info   string  optional    

Additional warranty information. Example: Standard 3-year warranty

status   string  optional    

Current status of the device. Example: available

Must be one of:
  • available
  • bought
  • defect
  • in use
  • not_delivered
  • sold
  • repair
  • not_set
function   string  optional    

The function or role of the device. Example: Server CPU

origin   string  optional    

The origin or source of the device. Example: Warehouse A

buy_price   number  optional    

Purchase price of the device. Example: 2500.5

appdata   object  optional    

Additional application-specific data for the device.

notes   string  optional    

Additional notes about the device. Example: Needs firmware update

metadata   object[]     
metadata_id   integer     

The ID of the metadata type. The id of an existing record in the types_fields table. Example: 37

value   string     

The value of the metadata entry. Example: 1

raw_value   string  optional    

Optional raw value for the metadata entry. Example: 1

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": 1712,
        "product_id": 0,
        "model_id": 2551,
        "parent_id": 0,
        "type_id": 3067,
        "user_id": 9756,
        "order_id": 1083,
        "location_id": 5534,
        "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": "King, Ruecker and Gulgowski",
        "serialnumber1": "SN975IK",
        "serialnumber2": null,
        "service_tag": "ST491KP",
        "comments": null,
        "label": "excepturi",
        "description": "Vel cupiditate labore voluptatem.",
        "purchase_date": "2024-11-12",
        "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=\"text-muted\">Unassigned</span>",
        "metadata": [],
        "device_traffic": null,
        "type": {
            "id": 3067,
            "name": "molestiae",
            "description": "Ipsa qui omnis mollitia.",
            "hardware": 1,
            "software": 1,
            "predefined": 1,
            "color": "green",
            "created_at": "2025-11-12 09:10:12",
            "updated_at": "2025-11-12 09:10:12"
        },
        "model": {
            "id": 2551,
            "name": "consequatur",
            "label": null,
            "type_id": 3067,
            "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": "2025-11-12T08:10:13.000000Z",
            "updated_at": "2025-11-12T08:10:13.000000Z"
        },
        "user": {
            "id": 9756,
            "username": "ztowne",
            "email": "[email protected]",
            "name": "Yazmin Konopelski",
            "firstname": "Yazmin",
            "lastname": "Konopelski",
            "gender": "0",
            "avatar": "//www.gravatar.com/avatar/08cc4467aae48bbd08e32af50732aa76?s=30&d=mm&r=g",
            "large_avatar": "//www.gravatar.com/avatar/08cc4467aae48bbd08e32af50732aa76?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": 5534,
            "app_id": null,
            "name": "Bashirian Group",
            "address": "63261 Demetrius Drive Suite 821\nBrekkemouth, OR 49301-7303",
            "city": "Schadenton",
            "state": "Washington",
            "description": "Amet omnis aliquid est ut cupiditate voluptas. Mollitia sed placeat laboriosam est. Molestiae sit ducimus pariatur ad soluta sed. Consequatur deserunt quisquam cupiditate eum et qui.",
            "notes": "Illo sit nisi voluptatem accusamus nobis. Dicta ad aut quis sed quis similique.",
            "emergency": "1",
            "phone": "248.407.4185",
            "flag": "UK.png",
            "created_at": "2025-11-12 09:10:12",
            "updated_at": "2025-11-12 09:10:12"
        },
        "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."
}

Request   

POST api/v3/admin/devices/{id}/metadata/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

slug   string     

The slug of the item metadata field. The slug of an existing record in the types_fields table. Example: ipmi.ip

value   string     

The value for the item metadata field. Example: 192.168.56.180

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."
}

Request   

POST api/v3/admin/devices/{id}/poll

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

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."
}

Request   

POST api/v3/admin/devices/{id}/discover

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

protocol   string     

Protocol with which device should be discovered. Example: SNMP

Must be one of:
  • Redfish
  • SNMP

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."
}

Request   

POST api/v3/admin/devices/{id}/power/action

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 123

Body Parameters

action   string     

The power action to perform. One of: boot, reboot, shutdown. Example: boot

Must be one of:
  • boot
  • reboot
  • shutdown

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."
}

Request   

POST api/v3/admin/devices/{id}/power/usage

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 101

Body Parameters

startDate   string  optional    

The start date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-01 00:00:00

endDate   string  optional    

The end date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-31 23:59:59

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."
}

Request   

POST api/v3/admin/devices/{id}/bandwidth

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 101

Body Parameters

startDate   string  optional    

The start date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-01 00:00:00

endDate   string  optional    

The end date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-31 23:59:59

units   string  optional    

The unit of bandwidth. Must be one of: MB, GB, TB. Example: GB

Must be one of:
  • MB
  • GB
  • TB
ports   object  optional    

An array of device port names to include in the traffic query.

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."
}

Request   

DELETE api/v3/admin/devices/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 5

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": 1352,
            "name": "qui blanditiis soluta",
            "status": "1",
            "message": "All Good!",
            "installed_version": "1.0",
            "created_at": "2025-11-12 09:10:14",
            "updated_at": "2025-11-12 09:10:14"
        },
        {
            "id": 1353,
            "name": "iusto quos quaerat",
            "status": "1",
            "message": "All Good!",
            "installed_version": "1.0",
            "created_at": "2025-11-12 09:10:14",
            "updated_at": "2025-11-12 09:10:14"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/remote-agents

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, status, created_at, updated_at. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, status, message. Example: id

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": 1354,
        "name": "aliquam et dolores",
        "status": "1",
        "message": "All Good!",
        "installed_version": "1.0",
        "created_at": "2025-11-12 09:10:14",
        "updated_at": "2025-11-12 09:10:14"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/remote-agents/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the Remote Agent. Example: 1

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": 1355,
        "name": "sequi modi eius",
        "status": "1",
        "message": "All Good!",
        "installed_version": "1.0",
        "created_at": "2025-11-12 09:10:14",
        "updated_at": "2025-11-12 09:10:14"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/remote-agents

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

host   string     

The IP or hostname of the remote agent. Example: 192.168.56.100

apikey   string     

API key used to authenticate the remote agent. Example: I4Vv1ZIgCXD6aykQF98kjuzG

name   string  optional    

Custom name of the remote agent. Example: Remote Agent #1

pxe_ip   string  optional    

PXE IP address used for provisioning. Defaults to the host IP. Example: 192.168.56.101

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."
}

Request   

DELETE api/v3/admin/remote-agents/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the Remote Agent. Example: 5

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": 70,
            "type": "ipv4",
            "subnet": "81.75.32.38",
            "mask": 24,
            "gateway": "174.22.219.150"
        },
        {
            "id": 71,
            "type": "ipv4",
            "subnet": "33.167.92.168",
            "mask": 24,
            "gateway": "138.221.154.69"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/remote-agents/{id}/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the Remote Agent. Example: 1

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, type, subnet, mask. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, type, subnet, gateway. Example: id

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/quia/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/quia/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/quia/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": 72,
        "type": "ipv4",
        "subnet": "228.140.35.209",
        "mask": 24,
        "gateway": "105.210.85.178"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/remote-agents/{id}/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the remote agent. Example: quia

Body Parameters

type   string     

Type of the subnet (IPv4). Example: ipv4

Must be one of:
  • ipv4
subnet   string     

Network subnet address. Example: 10.10.10.0

mask   number     

Subnet mask length. Must be at least 1. Must not be greater than 32. Example: 24

gateway   string     

Default gateway address. Example: 10.10.10.1

description   string  optional    

Optional subnet description. Must not be greater than 255 characters. Example: DHCP range for rack A

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/enim/subnets/aut" \
    --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/enim/subnets/aut'
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/enim/subnets/aut';
$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": 73,
        "type": "ipv4",
        "subnet": "162.193.194.221",
        "mask": 24,
        "gateway": "26.230.5.174"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/remote-agents/{id}/subnets/{subnetId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the remote agent. Example: enim

subnetId   string     

Example: aut

Body Parameters

type   string     

Type of the subnet (IPv4). Example: ipv4

Must be one of:
  • ipv4
subnet   string     

Network subnet address. Example: 10.10.10.0

mask   number     

Subnet mask length. Must be at least 1. Must not be greater than 32. Example: 24

gateway   string     

Default gateway address. Example: 10.10.10.1

description   string  optional    

Optional subnet description. Must not be greater than 255 characters. Example: DHCP range for rack A

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/voluptatem/subnets/asperiores" \
    --header "Authorization: Bearer {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/voluptatem/subnets/asperiores'
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/voluptatem/subnets/asperiores';
$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."
}

Request   

DELETE api/v3/admin/remote-agents/{id}/subnets/{subnetId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the remote agent. Example: voluptatem

subnetId   string     

Example: asperiores

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": 230,
            "name": "sunt-iso",
            "iso_url": "http://www.stiedemann.com/unde-ipsam-aut-hic-incidunt-hic-repellat",
            "status": 1,
            "status_label": "Waiting",
            "created_at": "2025-11-12 09:10:15",
            "updated_at": "2025-11-12 09:10:15"
        },
        {
            "id": 231,
            "name": "aut-iso",
            "iso_url": "http://leuschke.com/magnam-unde-necessitatibus-quas-omnis-id-quibusdam",
            "status": 4,
            "status_label": "Error",
            "created_at": "2025-11-12 09:10:15",
            "updated_at": "2025-11-12 09:10:15"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/os/isoimages

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, iso_url, status. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, iso_url, status. Example: id

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": 232,
        "name": "et-iso",
        "iso_url": "http://watsica.info/natus-sit-vel-voluptas-consequatur-totam-assumenda-animi",
        "status": 3,
        "status_label": "Finished",
        "created_at": "2025-11-12 09:10:15",
        "updated_at": "2025-11-12 09:10:15"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/os/isoimages/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ISO image. Example: 1

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": 233,
        "name": "minus-iso",
        "iso_url": "https://www.ortiz.com/eos-rerum-rerum-quam-commodi-perferendis-maxime",
        "status": 2,
        "status_label": "Started",
        "created_at": "2025-11-12 09:10:15",
        "updated_at": "2025-11-12 09:10:15"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/os/isoimages

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The display name for the ISO image. Must not be greater than 255 characters. Example: Ubuntu Server ISO

iso_url   string     

Direct URL to the ISO file. Must be publicly accessible and point to a valid .iso resource. Must be a valid URL. Example: https://example.com/images/ubuntu.iso

remoteApp   integer[]  optional    

Array of Remote Agent Ids. The id of an existing record in the remote_applications table.

availability   string     

Specifies whether the ISO image will be public. Example: public

Must be one of:
  • public
  • forSpecifiedUsers
users   integer[]  optional    

Array of User IDs. The id of an existing record in the users table.

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": 234,
        "name": "maiores-iso",
        "iso_url": "https://stracke.com/consequuntur-quos-ipsum-totam-et-quia-voluptas.html",
        "status": 4,
        "status_label": "Error",
        "created_at": "2025-11-12 09:10:15",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

PUT api/v3/admin/os/isoimages/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ISO image to update. Example: 3

Body Parameters

name   string  optional    

The display name for the ISO image. Must not be greater than 255 characters. Example: Ubuntu Server ISO

remoteApp   integer[]  optional    

Array od Remote Agent Ids. The id of an existing record in the remote_applications table.

availability   string  optional    

Specifies whether the ISO image will be public. Example: public

Must be one of:
  • public
  • forSpecifiedUsers
users   integer[]  optional    

Array of User Ids. The id of an existing record in the users table.

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."
}

Request   

DELETE api/v3/admin/os/isoimages/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ISO image to delete. Example: 3

List OS Templates

requires authentication

Returns a paginated list of OS templates.

Optionally, you can include a list of addons (based on template tags) by using the with_addons query parameter.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/os/templates?with_addons=1&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/os/templates'
params = {
  'with_addons': '1',
  'per_page': '10',
  'page': '1',
  'sort_by': 'id',
  'sort_dir': 'asc',
  'search_term': 'active,pending',
  'search_op': 'like',
  'search_fields': 'id',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'with_addons' => '1',
            'per_page' => '10',
            'page' => '1',
            'sort_by' => 'id',
            'sort_dir' => 'asc',
            'search_term' => 'active,pending',
            'search_op' => 'like',
            'search_fields' => 'id',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 303,
            "template_id": 303,
            "name": "et",
            "server_id": 788,
            "tags": [
                "blanditiis",
                "rerum",
                "accusantium",
                "quia",
                "mollitia",
                "nisi"
            ],
            "architecture": "x64",
            "cache_folder": "quisquam",
            "mirror": "https://borer.com/non-et-veritatis-alias-quo-laborum-totam.html",
            "edition": "quia",
            "iso_url": "http://weissnat.info/corrupti-a-beatae-fuga-atque-necessitatibus.html",
            "tftp_url": "http://www.thompson.com/ad-voluptatem-et-est-provident-distinctio-similique.html",
            "license": "at",
            "gpxe": "Sequi blanditiis eum voluptate ullam similique ad voluptas.",
            "disk_layout": "Ad eligendi nisi cumque maxime corporis ad at omnis.",
            "packages": "Repellendus aliquid non rem tempora et et hic.",
            "pre_installation": "Et eos provident et inventore incidunt.",
            "post_installation": "Occaecati accusantium tenetur ipsam harum ea.",
            "first_boot": "Rerum veniam laudantium qui reiciendis molestiae quia unde eius.",
            "extras": "Placeat sunt deleniti et et autem.",
            "timezone": "Australia/Darwin",
            "language": "ar",
            "family": "",
            "is_windows": false,
            "is_rescue": false,
            "servers": [
                {
                    "id": 788,
                    "app_id": 1393,
                    "name": "Ms. Marian Bogisich",
                    "module": "Remote Module",
                    "configuration": {
                        "app": 1393,
                        "rebootmethod": "manual",
                        "nameserver_1": "169.234.90.160",
                        "nameserver_2": null,
                        "emails_to_admin": null,
                        "admin": null,
                        "emails_to_client": null,
                        "rescue_template": null,
                        "reinstall_template": null,
                        "bootloader": null
                    },
                    "enabled": 1
                },
                {
                    "id": 789,
                    "app_id": 1394,
                    "name": "Verla Torp",
                    "module": "Remote Module",
                    "configuration": {
                        "app": 1394,
                        "rebootmethod": "manual",
                        "nameserver_1": null,
                        "nameserver_2": null,
                        "emails_to_admin": null,
                        "admin": null,
                        "emails_to_client": null,
                        "rescue_template": null,
                        "reinstall_template": null,
                        "bootloader": null
                    },
                    "enabled": 1
                }
            ]
        },
        {
            "id": 304,
            "template_id": 304,
            "name": "impedit",
            "server_id": 790,
            "tags": [
                "corrupti",
                "velit",
                "blanditiis",
                "quod",
                "excepturi",
                "optio"
            ],
            "architecture": "x86",
            "cache_folder": "rerum",
            "mirror": "http://johnson.com/sed-quia-non-vero-asperiores-autem-ipsum-doloremque.html",
            "edition": "aut",
            "iso_url": "https://www.renner.com/qui-aut-sint-perspiciatis-explicabo-minus",
            "tftp_url": "https://lang.com/iure-et-soluta-voluptatem-excepturi-adipisci.html",
            "license": "rerum",
            "gpxe": "Excepturi doloremque ducimus accusamus tenetur iste suscipit.",
            "disk_layout": "Ea vitae eius laborum quaerat pariatur temporibus aut.",
            "packages": "Sunt quaerat velit consequatur laudantium quidem amet.",
            "pre_installation": "Quia debitis corrupti voluptatum magnam est nemo ex doloremque.",
            "post_installation": "Placeat sapiente aspernatur autem quasi dolor.",
            "first_boot": "Placeat ullam asperiores quaerat consequatur accusantium quam ut.",
            "extras": "Blanditiis error facere dolorem aut inventore rerum.",
            "timezone": "Africa/Tripoli",
            "language": "cr",
            "family": "",
            "is_windows": false,
            "is_rescue": false,
            "servers": [
                {
                    "id": 790,
                    "app_id": 1395,
                    "name": "Bernardo Wehner",
                    "module": "Remote Module",
                    "configuration": {
                        "app": 1395,
                        "rebootmethod": "ipmi_easy_uefi",
                        "nameserver_1": null,
                        "nameserver_2": null,
                        "emails_to_admin": null,
                        "admin": null,
                        "emails_to_client": null,
                        "rescue_template": null,
                        "reinstall_template": null,
                        "bootloader": "ipxe1.0.0undionly.kkpxe"
                    },
                    "enabled": 0
                },
                {
                    "id": 791,
                    "app_id": 1396,
                    "name": "Ludwig Mayert",
                    "module": "Remote Module",
                    "configuration": {
                        "app": 1396,
                        "rebootmethod": "pdu",
                        "nameserver_1": null,
                        "nameserver_2": null,
                        "emails_to_admin": null,
                        "admin": null,
                        "emails_to_client": null,
                        "rescue_template": null,
                        "reinstall_template": null,
                        "bootloader": "ipxe1.0.0undionly.kkpxe"
                    },
                    "enabled": 0
                }
            ]
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/os/templates

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

with_addons   boolean  optional    

Optional. If set to true, includes a list of addons for each template. Example: true

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, edition, architecture, family. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, edition, architecture, tags. Example: id

Show OS Template

requires authentication

Returns detailed information about a specific template.

Optionally, you can include a list of addons (based on template tags) by using the with_addons query parameter.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/os/templates/1?with_addons=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/os/templates/1'
params = {
  'with_addons': '1',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/templates/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'with_addons' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 305,
        "template_id": 305,
        "name": "eaque",
        "server_id": 792,
        "tags": [
            "neque",
            "placeat",
            "et",
            "in",
            "sunt"
        ],
        "architecture": "x64",
        "cache_folder": "illo",
        "mirror": "http://swaniawski.biz/consectetur-quaerat-qui-fuga-officiis-non-vel",
        "edition": "laborum",
        "iso_url": "http://www.orn.com/autem-itaque-vitae-labore-et.html",
        "tftp_url": "http://www.dooley.com/",
        "license": "natus",
        "gpxe": "Cum provident est distinctio.",
        "disk_layout": "Animi sed provident quos eveniet dolore.",
        "packages": "Itaque omnis voluptatem sit quae fugiat.",
        "pre_installation": "Magnam et modi impedit eveniet quo.",
        "post_installation": "Laborum similique consectetur voluptate ipsam minus ex praesentium.",
        "first_boot": "Cupiditate iste expedita praesentium in voluptate atque fuga.",
        "extras": "Expedita et a quia consequatur repellat.",
        "timezone": "Europe/Guernsey",
        "language": "rm",
        "family": "",
        "is_windows": false,
        "is_rescue": false,
        "servers": [
            {
                "id": 792,
                "app_id": 1397,
                "name": "Amparo Collier II",
                "module": "Remote Module",
                "configuration": {
                    "app": 1397,
                    "rebootmethod": "ipmi_easy_uefi",
                    "nameserver_1": null,
                    "nameserver_2": "227.116.63.43",
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": "undionly.kpxe"
                },
                "enabled": 1
            },
            {
                "id": 793,
                "app_id": 1398,
                "name": "Prof. Narciso Goodwin",
                "module": "Remote Module",
                "configuration": {
                    "app": 1398,
                    "rebootmethod": "manual",
                    "nameserver_1": "143.108.84.183",
                    "nameserver_2": "91.23.29.62",
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": null
                },
                "enabled": 0
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/os/templates/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 1

Query Parameters

with_addons   boolean  optional    

Optional. If set to true, includes a list of addons for each template. Example: true

Create OS Template

requires authentication

Creates a new template with the provided details.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/os/templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Ubuntu 24\",
    \"server\": [
        1
    ],
    \"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_script\": \"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
    ],
    "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_script": "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,
            ],
            '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_script' => '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": 306,
        "template_id": 306,
        "name": "quibusdam",
        "server_id": 794,
        "tags": [
            "quo",
            "in",
            "consequatur"
        ],
        "architecture": "x86",
        "cache_folder": "qui",
        "mirror": "https://bartell.biz/quam-dolore-et-optio-qui-eum-sed.html",
        "edition": "voluptas",
        "iso_url": "http://kunde.info/eos-nisi-et-explicabo-adipisci.html",
        "tftp_url": "https://www.glover.com/velit-alias-dolorem-dolor-culpa-quam",
        "license": "hic",
        "gpxe": "Eum vel in non qui ipsa.",
        "disk_layout": "Quo molestiae sed beatae aut.",
        "packages": "Id amet beatae enim aut aut enim.",
        "pre_installation": "Soluta harum quo sapiente rem quo.",
        "post_installation": "Deserunt voluptas autem veritatis voluptatem.",
        "first_boot": "Corporis fugit voluptatibus aspernatur quia.",
        "extras": "Vitae et deserunt error cupiditate voluptas provident in.",
        "timezone": "America/Scoresbysund",
        "language": "vi",
        "family": "",
        "is_windows": false,
        "is_rescue": false,
        "servers": [
            {
                "id": 794,
                "app_id": 1399,
                "name": "Yolanda Daniel",
                "module": "Remote Module",
                "configuration": {
                    "app": 1399,
                    "rebootmethod": "ipmi_easy",
                    "nameserver_1": null,
                    "nameserver_2": null,
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": null
                },
                "enabled": 1
            },
            {
                "id": 795,
                "app_id": 1400,
                "name": "Prof. Alta Kilback",
                "module": "Remote Module",
                "configuration": {
                    "app": 1400,
                    "rebootmethod": "manual",
                    "nameserver_1": null,
                    "nameserver_2": "182.22.244.39",
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": "undionly.kpxe"
                },
                "enabled": 0
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/os/templates

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Any name for the installation template. Must not be greater than 255 characters. Example: Ubuntu 24

server   integer[]  optional    

Provisioning server Id. The id of an existing record in the os_servers table.

tags   string  optional    

Tags defining the installation template. Separated by space. Example: windows custom

architecture   string  optional    

System architecture of the installation template. Example: amd64

cache_folder   string  optional    

The name of the cache directory which stores the installation files on the remote agent server. Example: debian_bookworm

mirror   string  optional    

Mirror containing the installation files. Must be a valid URL. Example: http://ftp.debian.org/debian

edition   string  optional    

Edition of the installation template. Example: bookworm

iso_url   string  optional    

ISO image URL. Required for some installation templates. Must be a valid URL. Example: https://cdimage.debian.org/cdimage/unofficial/non-free/firmware/bookworm/current/firmware.cpio.gz

extract_iso   boolean  optional    

Specifies whether the ISO image should be extracted after downloading. Example: false

timezone   string  optional    

The timezone of the target operating system. Example: America/Los_Angeles

language   string  optional    

Language of the target operating system. Example: en_US

gpxe_script   string  optional    

Specifies the script to be executed during PXE boot. Example: Example GPXE script

disk_layout   string  optional    

Defines the partitioning method of the disk. This script depends on the specific distribution of the relational system. Example: Example Disk Layout script

packages   string  optional    

Specifies a list of system packages (each in a new line) that will be installed. Example: Example Packages

post_installation   string  optional    

Specifies the installation script that will be executed after the installation of the operating system. In the case of Linux systems, these are Bash language scripts. For Windows systems, they are PowerShell scripts. Example: Example Post Installation script

first_boot   string  optional    

Specifies the installation script that will be executed when the operating system first boots. Only for some systems such as Centos, Ubuntu or Debian. Example: Example First Boot script

Update OS Template

requires authentication

Updates template with the provided details and id.

Example request:
curl --request PUT \
    "https://your-easydcim.com/api/v3/admin/os/templates/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Ubuntu 24\",
    \"server\": [
        1
    ],
    \"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_script\": \"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
    ],
    "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_script": "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,
            ],
            '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_script' => '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": 307,
        "template_id": 307,
        "name": "dolor",
        "server_id": 796,
        "tags": [
            "qui",
            "et",
            "nemo",
            "dignissimos"
        ],
        "architecture": "arm",
        "cache_folder": "aut",
        "mirror": "http://www.emmerich.com/culpa-libero-quae-animi-sunt-vel-nihil",
        "edition": "repudiandae",
        "iso_url": "http://cormier.com/",
        "tftp_url": "https://www.frami.com/qui-ut-distinctio-placeat-eligendi-ullam-consectetur-praesentium",
        "license": "natus",
        "gpxe": "Saepe ullam doloremque assumenda in.",
        "disk_layout": "Veniam magnam reiciendis nesciunt libero aut sed.",
        "packages": "Qui omnis inventore quia reiciendis similique doloremque.",
        "pre_installation": "Omnis unde est tempora ullam ab adipisci.",
        "post_installation": "Autem culpa earum consequatur consequatur consequuntur velit.",
        "first_boot": "Quaerat quaerat id ex voluptates id error eaque.",
        "extras": "Et enim nulla ad dolorem sit omnis velit repudiandae.",
        "timezone": "Europe/Sofia",
        "language": "no",
        "family": "",
        "is_windows": false,
        "is_rescue": false,
        "servers": [
            {
                "id": 796,
                "app_id": 1401,
                "name": "Aida Crist",
                "module": "Remote Module",
                "configuration": {
                    "app": 1401,
                    "rebootmethod": "ipmi_easy",
                    "nameserver_1": null,
                    "nameserver_2": "15.193.68.139",
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": null
                },
                "enabled": 0
            },
            {
                "id": 797,
                "app_id": 1402,
                "name": "Heber Paucek",
                "module": "Remote Module",
                "configuration": {
                    "app": 1402,
                    "rebootmethod": "ipmi_easy_uefi",
                    "nameserver_1": "65.61.127.248",
                    "nameserver_2": "203.188.107.30",
                    "emails_to_admin": null,
                    "admin": null,
                    "emails_to_client": null,
                    "rescue_template": null,
                    "reinstall_template": null,
                    "bootloader": null
                },
                "enabled": 1
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/os/templates/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 1

Body Parameters

name   string  optional    

Any name for the installation template. Must not be greater than 255 characters. Example: Ubuntu 24

server   integer[]  optional    

Provisioning server Id. The id of an existing record in the os_servers table.

tags   string  optional    

Tags defining the installation template. Separated by space. Example: windows custom

architecture   string  optional    

System architecture of the installation template. Example: amd64

cache_folder   string  optional    

The name of the cache directory which stores the installation files on the remote agent server. Example: debian_bookworm

mirror   string  optional    

Mirror containing the installation files. Must be a valid URL. Example: http://ftp.debian.org/debian

edition   string  optional    

Edition of the installation template. Example: bookworm

iso_url   string  optional    

ISO image URL. Required for some installation templates. Must be a valid URL. Example: https://cdimage.debian.org/cdimage/unofficial/non-free/firmware/bookworm/current/firmware.cpio.gz

extract_iso   boolean  optional    

Specifies whether the ISO image should be extracted after downloading. Example: false

timezone   string  optional    

The timezone of the target operating system. Example: America/Los_Angeles

language   string  optional    

Language of the target operating system. Example: en_US

gpxe_script   string  optional    

Specifies the script to be executed during PXE boot. Example: Example GPXE script

disk_layout   string  optional    

Defines the partitioning method of the disk. This script depends on the specific distribution of the relational system. Example: Example Disk Layout script

packages   string  optional    

Specifies a list of system packages (each in a new line) that will be installed. Example: Example Packages

post_installation   string  optional    

Specifies the installation script that will be executed after the installation of the operating system. In the case of Linux systems, these are Bash language scripts. For Windows systems, they are PowerShell scripts. Example: Example Post Installation script

first_boot   string  optional    

Specifies the installation script that will be executed when the operating system first boots. Only for some systems such as Centos, Ubuntu or Debian. Example: Example First Boot script

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."
}

Request   

DELETE api/v3/admin/os/templates/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 1

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=8&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': '8',
  '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' => '8',
            '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": 126,
            "server_id": 798,
            "name": "Rebecca Miller",
            "description": "Facere accusantium facilis corporis in nulla qui.",
            "type": "disklayout",
            "tag": "voluptas quia",
            "tags": [
                "voluptas",
                "quia"
            ],
            "data": "Recusandae aut eius temporibus dolorem nihil."
        },
        {
            "id": 127,
            "server_id": 799,
            "name": "Bernhard Schmeler",
            "description": "Qui est suscipit id quo voluptatem ab dolorem.",
            "type": "firstboot",
            "tag": "voluptatem quidem",
            "tags": [
                "voluptatem",
                "quidem"
            ],
            "data": "Accusamus recusandae voluptatem voluptatem corporis voluptates velit."
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/os/addons

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

template_id   integer  optional    

Optional. If set returns filtered collection for provided OS Template id Example: 8

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, type, tag. Example: id

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": 128,
    "server_id": 800,
    "name": "Rene Fritsch",
    "description": "Corrupti odit maiores molestiae et deserunt.",
    "type": "postinstall",
    "tag": "placeat suscipit",
    "tags": [
        "placeat",
        "suscipit"
    ],
    "data": "Consequuntur qui id et soluta."
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/os/addons/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the addon. Example: 1

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\": \"veniam\",
    \"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": "veniam",
    "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' => 'veniam',
            '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": 129,
    "server_id": 801,
    "name": "Gloria Little",
    "description": "Doloribus tempore omnis hic illum.",
    "type": "postinstall",
    "tag": "nulla commodi",
    "tags": [
        "nulla",
        "commodi"
    ],
    "data": "Quo asperiores praesentium laborum voluptatem quos consequuntur."
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/os/addons

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Any name for the installation addon. Must not be greater than 255 characters. Example: cpanel

tag   string  optional    

Example: veniam

type   string     

Specifies the type of the installation addon. Example: disklayout

Must be one of:
  • disklayout
  • firstboot
  • postinstall
description   string  optional    

Any description for the installation addon. Example: Install cPanel

data   string  optional    

Specifies the script for the installation addon. Example: Example addon script

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\": \"doloribus\",
    \"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": "doloribus",
    "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' => 'doloribus',
            '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": 130,
    "server_id": 802,
    "name": "Elsa Ondricka",
    "description": "Qui quibusdam rerum qui dolor error est.",
    "type": "firstboot",
    "tag": "rem qui",
    "tags": [
        "rem",
        "qui"
    ],
    "data": "Et asperiores aut qui error animi ut minus."
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/os/addons/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the addon. Example: 1

Body Parameters

name   string  optional    

Any name for the installation addon. Must not be greater than 255 characters. Example: cpanel

tag   string  optional    

Example: doloribus

type   string  optional    

Specifies the type of the installation addon. Example: disklayout

Must be one of:
  • disklayout
  • firstboot
  • postinstall
description   string  optional    

Any description for the installation addon. Example: Install cPanel

data   string  optional    

Specifies the script for the installation addon. Example: Example addon script

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."
}

Request   

DELETE api/v3/admin/os/addons/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the addon. Example: 1

Install OS on Device

requires authentication

Initiates OS installation on a device

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/os/1/install" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"template\": 12,
    \"hostname\": \"server01.example.com\",
    \"username\": \"admin\",
    \"password\": \"secret123\",
    \"root_password\": \"rootsecret\",
    \"disk_addon\": 1,
    \"extras\": [
        20
    ],
    \"ssh_keys\": [
        4
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/os/1/install'
payload = {
    "template": 12,
    "hostname": "server01.example.com",
    "username": "admin",
    "password": "secret123",
    "root_password": "rootsecret",
    "disk_addon": 1,
    "extras": [
        20
    ],
    "ssh_keys": [
        4
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'template' => 12,
            'hostname' => 'server01.example.com',
            'username' => 'admin',
            'password' => 'secret123',
            'root_password' => 'rootsecret',
            'disk_addon' => 1,
            'extras' => [
                20,
            ],
            'ssh_keys' => [
                4,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 250,
        "device_id": 1716,
        "template_id": 308,
        "server_id": 803,
        "message": "Sed blanditiis reiciendis explicabo possimus quis porro maiores.",
        "dhcp": 1,
        "configuration": [],
        "log": "",
        "created_at": "2025-11-12 09:10:16",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

POST api/v3/admin/os/{deviceId}/install

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

Body Parameters

template   integer     

ID or identifier of the OS template to install. The id of an existing record in the os_templates table. Example: 12

hostname   string  optional    

Optional hostname for the new system. Example: server01.example.com

username   string     

Username for the new system. Example: admin

password   string     

Password for the user account. Example: secret123

root_password   string  optional    

Root password for the system (optional). Example: rootsecret

disk_addon   integer  optional    

Optional ID of an additional disk to use during installation. The id of an existing record in the os_addons table. Example: 1

extras   integer[]  optional    

The id of an existing record in the os_addons table.

ssh_keys   integer[]  optional    

The id of an existing record in the ssh_keys table.

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."
}

Request   

POST api/v3/admin/os/{deviceId}/cancel

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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": 251,
        "device_id": 1717,
        "template_id": 309,
        "server_id": 806,
        "message": "Tenetur doloribus sequi et eaque.",
        "dhcp": 1,
        "configuration": [],
        "log": "",
        "created_at": "2025-11-12 09:10:16",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

GET api/v3/admin/os/{deviceId}/install/information

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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": 252,
        "device_id": 1718,
        "template_id": 310,
        "server_id": 809,
        "message": "Quaerat voluptatem dolore labore et consequuntur debitis at.",
        "dhcp": 1,
        "configuration": [],
        "log": "",
        "created_at": "2025-11-12 09:10:17",
        "updated_at": "2025-11-12 09:10:17"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/os/{deviceId}/rescue/enable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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."
}

Request   

GET api/v3/admin/os/{deviceId}/rescue/status

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

Show Device Configuration

requires authentication

Returns device OS configuration.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/os/1/configuration" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "gateway": "192.168.56.1",
        "netmask": "255.255.255.0",
        "nameserver_1": "1.1.1.1",
        "nameserver_2": "8.8.8.8",
        "rebootmethod": "manual",
        "bootloader": "undionly.kpxe"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/os/{deviceId}/configuration

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

Update Device Configuration

requires authentication

Updates device OS configuration with the provided details and id.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/os/1/configuration" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"gateway\": \"192.168.1.1\",
    \"netmask\": \"255.255.255.0\",
    \"nameserver_1\": \"8.8.8.8\",
    \"nameserver_2\": \"8.8.4.4\",
    \"rebootmethod\": \"ipmi_easy\",
    \"bootloader\": \"undionly.kpxe\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration'
payload = {
    "gateway": "192.168.1.1",
    "netmask": "255.255.255.0",
    "nameserver_1": "8.8.8.8",
    "nameserver_2": "8.8.4.4",
    "rebootmethod": "ipmi_easy",
    "bootloader": "undionly.kpxe"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/os/1/configuration';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'gateway' => '192.168.1.1',
            'netmask' => '255.255.255.0',
            'nameserver_1' => '8.8.8.8',
            'nameserver_2' => '8.8.4.4',
            'rebootmethod' => 'ipmi_easy',
            'bootloader' => 'undionly.kpxe',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "gateway": "192.168.56.1",
        "netmask": "255.255.255.0",
        "nameserver_1": "1.1.1.1",
        "nameserver_2": "8.8.8.8",
        "rebootmethod": "manual",
        "bootloader": "undionly.kpxe"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/os/{deviceId}/configuration

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

Body Parameters

gateway   string  optional    

Optional gateway IP address. Must be a valid IP address. Example: 192.168.1.1

netmask   string  optional    

Optional subnet mask, must be one of the allowed CIDR netmask values. Example: 255.255.255.0

Must be one of:
  • 128.0.0.0
  • 192.0.0.0
  • 224.0.0.0
  • 240.0.0.0
  • 248.0.0.0
  • 252.0.0.0
  • 254.0.0.0
  • 255.0.0.0
  • 255.128.0.0
  • 255.192.0.0
  • 255.224.0.0
  • 255.240.0.0
  • 255.248.0.0
  • 255.252.0.0
  • 255.254.0.0
  • 255.255.0.0
  • 255.255.128.0
  • 255.255.192.0
  • 255.255.224.0
  • 255.255.240.0
  • 255.255.248.0
  • 255.255.252.0
  • 255.255.254.0
  • 255.255.255.0
  • 255.255.255.128
  • 255.255.255.192
  • 255.255.255.224
  • 255.255.255.240
  • 255.255.255.248
  • 255.255.255.252
  • 255.255.255.254
  • 255.255.255.255
nameserver_1   string  optional    

Optional first nameserver address. Example: 8.8.8.8

nameserver_2   string  optional    

Optional second nameserver address. Example: 8.8.4.4

rebootmethod   string  optional    

Optional reboot method. Example: ipmi_easy

Must be one of:
  • ipmi_easy
  • ipmi_easy_uefi
  • pdu
  • manual
bootloader   string  optional    

Optional bootloader type. Example: undionly.kpxe

Must be one of:
  • ipxe1.0.0undionly.kkpxe
  • undionly.kpxe
  • vmware.kpxe

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": 812,
        "app_id": 1417,
        "name": "Joshuah Kulas",
        "module": "Remote Module",
        "configuration": {
            "app": 1417,
            "rebootmethod": "ipmi_easy_uefi",
            "nameserver_1": null,
            "nameserver_2": "195.221.96.174",
            "emails_to_admin": null,
            "admin": null,
            "emails_to_client": null,
            "rescue_template": null,
            "reinstall_template": null,
            "bootloader": null
        },
        "enabled": 1
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/os/{id}/provisioning/server

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the location or device. Example: 1

Query Parameters

find_by_type   string  optional    

Optional. One of location, device. If not set default to device. Example: device

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": 253,
            "device_id": 1719,
            "template_id": 311,
            "server_id": 813,
            "message": "Incidunt aut quaerat et nam molestiae.",
            "dhcp": 1,
            "configuration": [],
            "log": "",
            "created_at": "2025-11-12 09:10:17",
            "updated_at": "2025-11-12 09:10:17"
        },
        {
            "id": 254,
            "device_id": 1720,
            "template_id": 312,
            "server_id": 816,
            "message": "Voluptas nisi qui voluptas atque maxime quae aut.",
            "dhcp": 1,
            "configuration": [],
            "log": "",
            "created_at": "2025-11-12 09:10:18",
            "updated_at": "2025-11-12 09:10:18"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/os/provisioning/tasks

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, server_id, template_id, message. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, template_id, message. Example: id

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": 154,
            "device_id": 1721,
            "server_id": 819,
            "template": "Cordie Gottlieb",
            "status": "",
            "log": "",
            "created_at": "2025-11-12 09:10:18",
            "updated_at": "2025-11-12 09:10:18"
        },
        {
            "id": 155,
            "device_id": 1722,
            "server_id": 820,
            "template": "Rick Effertz",
            "status": "",
            "log": "",
            "created_at": "2025-11-12 09:10:18",
            "updated_at": "2025-11-12 09:10:18"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/os/provisioning/history

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, server_id, status. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, status, template. Example: id

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": 170,
            "app_id": 1427,
            "name": "Ahmad Legros",
            "locations": [
                {
                    "id": 5583,
                    "app_id": null,
                    "name": "Abernathy, Willms and Tillman",
                    "address": "33568 Olson Hill Suite 270\nLake Aida, FL 10205-3409",
                    "city": "Hansenhaven",
                    "state": "Minnesota",
                    "description": "Dolore et facere odio quidem eum earum eum facere. Culpa culpa itaque similique fuga. Sed nemo dolor ea dignissimos asperiores nam esse. Non perspiciatis id ex sed aut dolorem sunt.",
                    "notes": "Culpa eos ut itaque ab possimus sed delectus. Cumque dolores minima sed nulla ut eum vero. Eos laborum commodi ducimus expedita aut ea temporibus.",
                    "emergency": "1",
                    "phone": "+1 (636) 919-7126",
                    "flag": "USA.png",
                    "created_at": "2025-11-12 09:10:19",
                    "updated_at": "2025-11-12 09:10:19"
                },
                {
                    "id": 5584,
                    "app_id": null,
                    "name": "Batz PLC",
                    "address": "9669 Kendrick Junctions Suite 887\nMarjorieville, NY 20985",
                    "city": "New Aurelioside",
                    "state": "Maine",
                    "description": "Voluptatibus asperiores ratione consequuntur nostrum. Hic et omnis tempore. Eaque cum sit est nulla odit. Id odit quia dolores mollitia eveniet.",
                    "notes": "Illo natus reiciendis consequatur dolorum qui nihil. Officia qui et harum occaecati reprehenderit nesciunt quia.",
                    "emergency": "0",
                    "phone": "+1-423-651-1754",
                    "flag": "Germany.png",
                    "created_at": "2025-11-12 09:10:19",
                    "updated_at": "2025-11-12 09:10:19"
                }
            ],
            "configuration": []
        },
        {
            "id": 171,
            "app_id": 1428,
            "name": "Casimir Carroll",
            "locations": [
                {
                    "id": 5585,
                    "app_id": null,
                    "name": "Murray-Gerlach",
                    "address": "76790 Buddy Causeway Suite 928\nLake Brandon, IL 88251",
                    "city": "Yostberg",
                    "state": "Kentucky",
                    "description": "Repellat repellendus laudantium necessitatibus recusandae in dolores. Tempora inventore omnis est quam. Itaque qui incidunt qui non a quia. Molestiae eum quis numquam.",
                    "notes": "Architecto a cum neque deserunt. Voluptate sapiente sequi corrupti.",
                    "emergency": "0",
                    "phone": "(906) 819-3441",
                    "flag": "Canada.png",
                    "created_at": "2025-11-12 09:10:19",
                    "updated_at": "2025-11-12 09:10:19"
                },
                {
                    "id": 5586,
                    "app_id": null,
                    "name": "Kassulke and Sons",
                    "address": "451 Schuster Plains Apt. 725\nNew Stanleytown, VA 67862",
                    "city": "Earlville",
                    "state": "Missouri",
                    "description": "Rerum aliquid expedita accusamus animi. Sunt rem eius eveniet dolorum. Fugit officiis facilis aut similique mollitia modi. Aut rerum cumque alias vero dolor.",
                    "notes": "Explicabo nam sequi quae adipisci. Minus dicta inventore possimus at aliquam.",
                    "emergency": "0",
                    "phone": "364.552.6283",
                    "flag": "UK.png",
                    "created_at": "2025-11-12 09:10:19",
                    "updated_at": "2025-11-12 09:10:19"
                }
            ],
            "configuration": []
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipmi/proxy/servers

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

with_sessions   boolean  optional    

Optional. If set to true, includes a list of sessions for each proxy server. Example: true

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, app_id, name. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, app_id, name. Example: id

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": 172,
        "app_id": 1429,
        "name": "Ruthie Gutkowski",
        "locations": [
            {
                "id": 5587,
                "app_id": null,
                "name": "Hartmann-Feil",
                "address": "8324 Golda Plains Suite 404\nNicolasland, VT 47879",
                "city": "East Angeline",
                "state": "Iowa",
                "description": "Enim recusandae accusantium voluptatem et. Autem error enim quia perspiciatis voluptatibus itaque. Molestiae laboriosam ipsum omnis ab id beatae. Enim ducimus doloribus maiores ab voluptatibus facilis. Blanditiis incidunt odio expedita enim voluptatem consequatur quis.",
                "notes": "Maxime doloribus et nobis. Est reprehenderit est esse numquam voluptatem. Consequuntur corrupti porro vitae aspernatur inventore iste deserunt. Eos ipsa est saepe minus dolorum.",
                "emergency": "1",
                "phone": "+1-631-905-3820",
                "flag": "Canada.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            },
            {
                "id": 5588,
                "app_id": null,
                "name": "Erdman PLC",
                "address": "738 Hassan Turnpike\nNorth Derick, AL 41609",
                "city": "Reinamouth",
                "state": "Georgia",
                "description": "Aperiam ea ut sunt recusandae est perferendis accusamus. Ex quia dolorum aut itaque. Quis at inventore itaque molestias aperiam sit commodi. Rerum consequatur dolores voluptatem voluptas.",
                "notes": "Quis molestiae vero velit officiis atque numquam atque. Delectus modi aut non fugiat ipsum quos rerum. Tempora vitae quam exercitationem exercitationem nam.",
                "emergency": "0",
                "phone": "734.657.3698",
                "flag": "Germany.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            }
        ],
        "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."
}

Request   

GET api/v3/admin/ipmi/proxy/servers/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the proxy server. Example: 1

Query Parameters

with_sessions   boolean  optional    

Optional. If set to true, includes a list of sessions. Example: true

Create Proxy Server

requires authentication

Creates a new proxy server with the provided details.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Main IPMI Proxy\",
    \"app_id\": 12,
    \"location\": [
        9
    ],
    \"proxy_type\": \"console\",
    \"java_version\": \"jdk1.8.0_121\",
    \"enable_firewall\": false,
    \"firewall_rules\": \"iptables -N ALLOW_ONLY\\n                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\\n                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\\n                              iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT\\n                              iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT\\n                              iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT\\n                              iptables -A OUTPUT -j DROP\",
    \"disable_login_buttons\": false
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers'
payload = {
    "name": "Main IPMI Proxy",
    "app_id": 12,
    "location": [
        9
    ],
    "proxy_type": "console",
    "java_version": "jdk1.8.0_121",
    "enable_firewall": false,
    "firewall_rules": "iptables -N ALLOW_ONLY\n                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\n                              iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT\n                              iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT\n                              iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT\n                              iptables -A OUTPUT -j DROP",
    "disable_login_buttons": false
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipmi/proxy/servers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Main IPMI Proxy',
            'app_id' => 12,
            'location' => [
                9,
            ],
            'proxy_type' => 'console',
            'java_version' => 'jdk1.8.0_121',
            'enable_firewall' => false,
            'firewall_rules' => 'iptables -N ALLOW_ONLY'."\n"
                .'                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT'."\n"
                .'                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY'."\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": 173,
        "app_id": 1430,
        "name": "Dr. Madisen Konopelski DVM",
        "locations": [
            {
                "id": 5589,
                "app_id": null,
                "name": "Kihn and Sons",
                "address": "991 Marlon Glens\nNorth Sydneyfort, WY 79771-7098",
                "city": "West Mallietown",
                "state": "West Virginia",
                "description": "Sapiente inventore nihil non sunt id vel aut aut. Rerum illo omnis ut aperiam voluptates recusandae et.",
                "notes": "Doloribus voluptates quod quia. Consequuntur optio inventore vel minus provident. Iure beatae ullam dolor quas. Vel nam consectetur modi at quaerat repellat.",
                "emergency": "1",
                "phone": "(530) 465-9518",
                "flag": "UK.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            },
            {
                "id": 5590,
                "app_id": null,
                "name": "Waters-Dibbert",
                "address": "46862 Boris Squares Suite 835\nLesterview, MO 68669-3422",
                "city": "Alfonsofort",
                "state": "Vermont",
                "description": "Odio architecto et necessitatibus non dignissimos qui occaecati. Pariatur et saepe ab. Consequuntur non qui eveniet qui sunt. Repudiandae ea quasi et unde rerum suscipit.",
                "notes": "Minima architecto nihil asperiores modi tempore omnis deleniti. Assumenda mollitia laudantium ut qui asperiores pariatur est ratione. Fugiat praesentium ad ut et deleniti.",
                "emergency": "1",
                "phone": "+1-740-593-9603",
                "flag": "Canada.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            }
        ],
        "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."
}

Request   

POST api/v3/admin/ipmi/proxy/servers

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Remote agent we want to use. Must not be greater than 255 characters. Example: Main IPMI Proxy

app_id   integer     

Select a remote application ID. The id of an existing record in the remote_applications table. Example: 12

location   integer[]  optional    

The id of an existing record in the locations table.

proxy_type   string  optional    

You can select the action that will be performed after starting the proxy. Example: console

Must be one of:
  • console
  • panel
  • panel-debug
java_version   string  optional    

You can specify the Java version that will be used in the noVNC session for Docker. Example: jdk1.8.0_121

Must be one of:
  • jdk1.8.0_121
  • jdk1.7.0_80
  • jre1.8.0_251
  • OpenWebStart
enable_firewall   boolean  optional    

Firewall is used to restrict access to websites. Enable this option to set up firewall rules. Example: false

firewall_rules   string  optional    

A script with firewall rules is automatically generated.
"{{:ipmi.ip}}" and "{{:ipmi.kvmport}}" will be replaced with the server IPMI IP Address and IPMI KVM Remote Port.
Edit the script to add your rules. Example: iptables -N ALLOW_ONLY iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT iptables -A OUTPUT -j DROP

disable_login_buttons   boolean  optional    

Login buttons are used to send login and password to the manufacturer panel form. Example: false

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\": [
        14
    ],
    \"proxy_type\": \"console\",
    \"java_version\": \"jdk1.8.0_121\",
    \"enable_firewall\": false,
    \"firewall_rules\": \"iptables -N ALLOW_ONLY \\n                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\\n                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\\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": [
        14
    ],
    "proxy_type": "console",
    "java_version": "jdk1.8.0_121",
    "enable_firewall": false,
    "firewall_rules": "iptables -N ALLOW_ONLY \n                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\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' => [
                14,
            ],
            'proxy_type' => 'console',
            'java_version' => 'jdk1.8.0_121',
            'enable_firewall' => false,
            'firewall_rules' => 'iptables -N ALLOW_ONLY '."\n"
                .'                              iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT'."\n"
                .'                              iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY'."\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": 174,
        "app_id": 1431,
        "name": "Eddie Nitzsche",
        "locations": [
            {
                "id": 5591,
                "app_id": null,
                "name": "Kris Inc",
                "address": "9129 Selina Garden Suite 379\nJontown, NE 48381-8754",
                "city": "Willstad",
                "state": "South Dakota",
                "description": "Sunt nemo necessitatibus dicta ut unde ex. Repudiandae autem temporibus fugit temporibus laborum officia deserunt. Quia consequatur adipisci quia natus.",
                "notes": "Eius perferendis voluptatibus ut eaque. Illo debitis voluptates laudantium. Dicta voluptas culpa ipsa numquam veritatis. Aliquam quod laboriosam dolores veniam voluptatem et.",
                "emergency": "0",
                "phone": "1-989-548-6333",
                "flag": "USA.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            },
            {
                "id": 5592,
                "app_id": null,
                "name": "Mann Inc",
                "address": "926 Dennis Corners Suite 670\nEast Maye, VA 63890-2103",
                "city": "Walshbury",
                "state": "California",
                "description": "Accusantium laudantium temporibus aliquam quibusdam facere. Fugit autem dolor non vero. Fuga consequatur enim eaque consequatur.",
                "notes": "Aliquid nostrum quibusdam rerum inventore. Beatae temporibus voluptatem perspiciatis. Numquam assumenda ipsa autem reprehenderit iure excepturi. Nihil dolores aut optio quisquam ad quis.",
                "emergency": "1",
                "phone": "+1-620-876-5552",
                "flag": "Germany.png",
                "created_at": "2025-11-12 09:10:19",
                "updated_at": "2025-11-12 09:10:19"
            }
        ],
        "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."
}

Request   

PUT api/v3/admin/ipmi/proxy/servers/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the proxy server. Example: 1

Body Parameters

name   string  optional    

Remote agent we want to use. Must not be greater than 255 characters. Example: Main IPMI Proxy

app_id   integer  optional    

Select a remote application ID. The id of an existing record in the remote_applications table. Example: 12

location   integer[]  optional    

The id of an existing record in the locations table.

proxy_type   string  optional    

You can select the action that will be performed after starting the proxy. Example: console

Must be one of:
  • console
  • panel
  • panel-debug
java_version   string  optional    

You can specify the Java version that will be used in the noVNC session for Docker. Example: jdk1.8.0_121

Must be one of:
  • jdk1.8.0_121
  • jdk1.7.0_80
  • jre1.8.0_251
  • OpenWebStart
enable_firewall   boolean  optional    

Firewall is used to restrict access to websites. Enable this option to set up firewall rules. Example: false

firewall_rules   string  optional    

A script with firewall rules is automatically generated.
"{{:ipmi.ip}}" and "{{:ipmi.kvmport}}" will be replaced with the server IPMI IP Address and IPMI KVM Remote Port.
Edit the script to add your rules. Example: iptables -N ALLOW_ONLY iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT iptables -A OUTPUT -j DROP

disable_login_buttons   boolean  optional    

Login buttons are used to send login and password to the manufacturer panel form. Example: false

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."
}

Request   

DELETE api/v3/admin/ipmi/proxy/servers/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the addon. Example: 1

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": 196,
            "device_id": 1724,
            "ipmi_proxy_id": 175,
            "url": "https://easydcim-shift.local/client/console/43377/k7CMBKrt/8c80ff49d2eb9d1a80d70548e52f33e6be9e7a7e",
            "status": 1,
            "message": "Rerum quae sunt non placeat quo sint aut.",
            "log": null
        },
        {
            "id": 197,
            "device_id": 1725,
            "ipmi_proxy_id": 176,
            "url": "https://easydcim-shift.local/client/console/14115/NnJe2loj/91fb484a5aaf01c2c967c1094b571a3bd4917dad",
            "status": 1,
            "message": "Et enim consequatur eaque saepe praesentium.",
            "log": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipmi/proxy/sessions

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, ipmi_proxy_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, ipmi_proxy_id. Example: id

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": 198,
        "device_id": 1726,
        "ipmi_proxy_id": 177,
        "url": "https://easydcim-shift.local/client/console/26017/Rd2AuAXv/bf70926f43dbabf9c1c7c6ab771ad1fe7bb1e766",
        "status": 1,
        "message": "Fugiat illo autem autem et.",
        "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."
}

Request   

GET api/v3/admin/ipmi/proxy/sessions/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the proxy session. Example: 1

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."
}

Request   

DELETE api/v3/admin/ipmi/proxy/sessions/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the proxy session. Example: 1

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": 199,
        "device_id": 1727,
        "ipmi_proxy_id": 178,
        "url": "https://easydcim-shift.local/client/console/55149/T30rbNwZ/1c93a487d245b1564864ab18e2778ffbd3b59e0a",
        "status": 1,
        "message": "Consequatur totam aspernatur est architecto ut.",
        "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."
}

Request   

POST api/v3/admin/ipmi/{deviceId}/novnc-connect

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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."
}

Request   

POST api/v3/admin/ipmi/{deviceId}/power-status

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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."
}

Request   

POST api/v3/admin/ipmi/{deviceId}/bmc-reset-cold

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

deviceId   integer     

The ID of the device. Example: 1

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": 105,
            "device_id": 1730,
            "user_id": 9927,
            "server_id": 153,
            "ip": "123.213.143.208",
            "from": "roob.org",
            "name": "streich.com",
            "ttl": "3600",
            "created_at": "2025-11-12 09:10:23",
            "updated_at": "2025-11-12 09:10:23"
        },
        {
            "id": 106,
            "device_id": 1731,
            "user_id": 9935,
            "server_id": 154,
            "ip": "88.248.240.212",
            "from": "auer.com",
            "name": "shanahan.info",
            "ttl": "3600",
            "created_at": "2025-11-12 09:10:23",
            "updated_at": "2025-11-12 09:10:23"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/dns-manager/rdns

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, user_id, server_id, ip, from, name, ttl. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, user_id, server_id, ip, from, name. Example: id

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": 107,
        "device_id": 1732,
        "user_id": 9943,
        "server_id": 155,
        "ip": "151.133.227.143",
        "from": "ferry.net",
        "name": "johns.com",
        "ttl": "3600",
        "created_at": "2025-11-12 09:10:23",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

POST api/v3/admin/dns-manager/rdns

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

ip   string     

The IP address to associate with the reverse DNS record. Must be a valid IP address. Example: 192.168.1.1

rdata   string     

The domain name (PTR) that should resolve for the IP. Example: example.mydomain.com

device_id   integer     

The ID of the device this record is associated with. Example: 1

ttl   integer  optional    

Optional TTL (Time To Live) value for the record in seconds. Must be at least 60. Example: 3600

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": 108,
        "device_id": 1733,
        "user_id": 9951,
        "server_id": 156,
        "ip": "12.217.246.252",
        "from": "beier.info",
        "name": "willms.info",
        "ttl": "3600",
        "created_at": "2025-11-12 09:10:24",
        "updated_at": "2025-11-12 09:10:24"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/dns-manager/rdns/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the rDNS record. Example: 456

Body Parameters

rdata   string     

The domain name (PTR) to update for this record. Example: updated.example.net

ttl   integer  optional    

Optional TTL (Time To Live) value in seconds. Must be at least 60. Example: 3600

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."
}

Request   

DELETE api/v3/admin/dns-manager/rdns/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the rDNS record. Example: 456

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": 54,
            "device_id": 1734,
            "server_id": 157,
            "ip": "247.58.15.41",
            "name": "rogahn.net",
            "created_at": "2025-11-12 09:10:24",
            "updated_at": "2025-11-12 09:10:24"
        },
        {
            "id": 55,
            "device_id": 1735,
            "server_id": 158,
            "ip": "76.13.178.5",
            "name": "hodkiewicz.com",
            "created_at": "2025-11-12 09:10:25",
            "updated_at": "2025-11-12 09:10:25"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/dns-manager/zones

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, server_id, ip, name. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, ip, name. Example: id

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": 56,
        "device_id": 1736,
        "server_id": 159,
        "ip": "230.53.197.247",
        "name": "simonis.info",
        "created_at": "2025-11-12 09:10:25",
        "updated_at": "2025-11-12 09:10:25"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/dns-manager/zones

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

ip   string     

The IP address of the zone. Must be a valid IP address. Example: 192.168.1.1

name   string     

Domain name of the zone. Must match the regex /^(?!:\/\/)([a-zA-Z0-9-_]+.)+[a-zA-Z]{2,}$/i. Example: example.mydomain.com

device_id   integer     

The ID of the device this record is associated with. Example: 1

server_id   integer     

The server id of connection used for creating zone. Example: 1

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."
}

Request   

DELETE api/v3/admin/dns-manager/zones/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the zone. Example: 13

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."
}

Request   

GET api/v3/admin/dns-manager/zones/{id}/records

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the zone. Example: 11

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."
}

Request   

POST api/v3/admin/dns-manager/zones/{id}/records/create

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the zone. Example: 11

Body Parameters

name   string     

The hostname or record name. Example: www

type   string     

DNS record type. Example: A

Must be one of:
  • A
  • AAAA
  • AFSDB
  • CNAME
  • DEF
  • DNAME
  • DS
  • HINFO
  • ISDN
  • LOC
  • MB
  • MD
  • MF
  • MG
  • MINFO
  • MR
  • MX
  • NAPTR
  • NS
  • PTR
  • RP
  • SOA
  • SPF
  • SRV
  • TXT
  • WKS
  • X25
ttl   integer  optional    

Time-to-live in seconds (minimum 60). Must be at least 60. Example: 3600

fields   object     

Required object for provided type. Object type one from (A, AAAA, AFSDB, CNAME, DEF, DNAME, DS, HINFO, ISDN, LOC, MB, MD, MF, MG, MINFO, MR, MX, NAPTR, NS, PTR, RP, SOA, SPF, SRV, TXT, WKS, X25).
A   object  optional    
address   string  optional    

A 32-bit IPv4 address (required if type=A). This field is required when type is A. Example: 192.0.2.1

AAAA   object  optional    
address   string  optional    

A 128-bit IPv6 address (required if type=AAAA). This field is required when type is AAAA. Example: 2001:db8::1

AFSDB   object  optional    
subtype   string  optional    

AFSDB subtype, either 1 (DFS) or 2 (DCE). This field is required when type is AFSDB. Example: 1

Must be one of:
  • 1
  • 2
hostname   string  optional    

Hostname associated with the AFSDB record. This field is required when type is AFSDB. Example: host.example.com

CNAME   object  optional    
cname   string  optional    

Canonical domain name for the alias. The owner name is the alias. This field is required when type is CNAME. Example: example.com

DEF   object  optional    
value   string  optional    

The value for the DEF record. This field is required when type is DEF. Example: Some value

DNAME   object  optional    
target   string  optional    

Target domain name to which the owner domain is aliased. This field is required when type is DNAME. Example: example.com

DS   object  optional    
keytag   integer  optional    

Key tag of the DNSKEY record this DS record refers to. This field is required when type is DS. Example: 12345

algorithm   integer  optional    

Algorithm number used by the DNSKEY. This field is required when type is DS. Example: 8

digesttype   integer  optional    

Digest type used to create the digest. This field is required when type is DS. Example: 1

digest   string  optional    

Digest of the referenced DNSKEY record. This field is required when type is DS. Example: 49FD46E6C4B45C55D4AC

HINFO   object  optional    
cpu   string  optional    

CPU type of the host machine. This field is required when type is HINFO. Example: Intel

os   string  optional    

Operating system type of the host machine. This field is required when type is HINFO. Example: Linux

ISDN   object  optional    
isdnaddress   string  optional    

ISDN address for the record (e.g., telephone number). This field is required when type is ISDN. Example: +1-555-1234567

sa   string  optional    

Subaddress associated with the ISDN address (optional). Example: 123

LOC   object  optional    
version   integer  optional    

LOC record version (optional, usually 0). Example: 0

size   number  optional    

Diameter of the sphere representing the location (optional). Example: 1

horiz_pre   number  optional    

Horizontal precision in meters (optional). Example: 100

vert_pre   number  optional    

Vertical precision in meters (optional). Example: 10

latitude   string  optional    

Latitude of the location (required if type=LOC). This field is required when type is LOC. Example: 52 22 23.0 N

longitude   string  optional    

Longitude of the location (required if type=LOC). This field is required when type is LOC. Example: 4 53 32.0 E

altitude   number  optional    

Altitude of the location in meters (optional). Example: 5

MB   object  optional    
madname   string  optional    

Domain name of the host which has the specified mailbox. This field is required when type is MB. Example: mail.example.com

MD   object  optional    
madname   string  optional    

Domain name of the host which has a mail agent for the domain. This field is required when type is MD. Example: mail.example.com

MF   object  optional    
madname   string  optional    

Domain name of the host which has a mail agent for forwarding mail to the domain. This field is required when type is MF. Example: forwarder.example.com

MG   object  optional    
mgmname   string  optional    

Domain name of the mailbox which is a member of the mail group. This field is required when type is MG. Example: member.example.com

MINFO   object  optional    
rmailbx   string  optional    

Mailbox responsible for the mailing list or mailbox. This field is required when type is MINFO. Example: responsible.example.com

emailbx   string  optional    

Mailbox to receive error messages related to the mailing list or mailbox. This field is required when type is MINFO. Example: [email protected]

MR   object  optional    
newname   string  optional    

Mailbox which is the proper rename of the specified mailbox. This field is required when type is MR. Example: newmail.example.com

MX   object  optional    
preference   integer  optional    

Preference value for the mail exchange; lower values are preferred. This field is required when type is MX. Must be at least 0. Must not be greater than 65535. Example: 10

exchange   string  optional    

Domain name of the host willing to act as a mail exchange for the owner. This field is required when type is MX. Example: mail.example.com

NAPTR   object  optional    
order   integer  optional    

Order in which the NAPTR record is processed. This field is required when type is NAPTR. Must be at least 0. Example: 100

preference   integer  optional    

Preference for records with the same order; lower values are preferred. This field is required when type is NAPTR. Must be at least 0. Example: 10

flags   string  optional    

Flags controlling the rewriting and interpretation of the record. This field is required when type is NAPTR. Example: U

services   string  optional    

Services available via this NAPTR record (e.g., E2U+sip). This field is required when type is NAPTR. Example: E2U+sip

regexp   string  optional    

Regular expression used to rewrite the original string (optional). Example: !^.*$!sip:[email protected]!

replacement   string  optional    

Replacement domain name if the regexp is not used. This field is required when type is NAPTR. Example: example.com

NS   object  optional    
nsdname   string  optional    

Domain name of the host which should be authoritative for the domain. This field is required when type is NS. Example: ns1.example.com

PTR   object  optional    
ptrdname   string  optional    

Domain name that the PTR record points to in the DNS namespace. This field is required when type is PTR. Example: host.example.com

RP   object  optional    
mbox   string  optional    

Mailbox responsible for the domain or owner. This field is required when type is RP. Example: admin.example.com

txtdname   string  optional    

Domain name containing additional text information. This field is required when type is RP. Example: info.example.com

SOA   object  optional    
mname   string  optional    

Primary name server for the zone. This field is required when type is SOA. Example: ns1.example.com

rname   string  optional    

Mailbox of the person responsible for the zone. This field is required when type is SOA. Example: admin.example.com

serial   integer  optional    

Serial number of the zone; incremented on changes. This field is required when type is SOA. Must be at least 0. Example: 2025090901

refresh   integer  optional    

Time interval before the zone should be refreshed (seconds). This field is required when type is SOA. Must be at least 0. Example: 3600

retry   integer  optional    

Time interval before a failed refresh should be retried (seconds). This field is required when type is SOA. Must be at least 0. Example: 1800

expire   integer  optional    

Time interval before the zone is no longer authoritative (seconds). This field is required when type is SOA. Must be at least 0. Example: 604800

minimum   integer  optional    

Minimum TTL for records in this zone (seconds). This field is required when type is SOA. Must be at least 0. Example: 86400

SPF   object  optional    
txtdata   string  optional    

SPF record data specifying allowed sending hosts for the domain. This field is required when type is SPF. Example: "v=spf1 include:example.com ~all"

SRV   object  optional    
priority   integer  optional    

Priority of the target host; lower values are preferred. This field is required when type is SRV. Must be at least 0. Example: 10

weight   integer  optional    

Relative weight for records with the same priority. This field is required when type is SRV. Must be at least 0. Example: 5

port   integer  optional    

Port on which the service is running (0-65535). This field is required when type is SRV. Must be at least 0. Must not be greater than 65535. Example: 5060

target   string  optional    

Domain name of the target host providing the service. This field is required when type is SRV. Example: sip.example.com

TXT   object  optional    
txtdata   string  optional    

Text data for the TXT record; one or more character strings. This field is required when type is TXT. Example: "v=spf1 include:example.com ~all"

WKS   object  optional    
address   string  optional    

32-bit IPv4 address. This field is required when type is WKS. Example: 192.0.2.1

protocol   integer  optional    

8-bit IP protocol number. This field is required when type is WKS. Must be at least 0. Must not be greater than 255. Example: 6

bitmap   string  optional    

Variable length bitmap; must be a multiple of 8 bits. This field is required when type is WKS. Example: 0101010100000000

X25   object  optional    
psdnaddress   string  optional    

Public Switched Data Network (PSDN) address. This field is required when type is X25. Example: 1234567890

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."
}

Request   

DELETE api/v3/admin/dns-manager/zones/{id}/records/delete

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the zone. Example: 5

Body Parameters

line   integer     

The line id of zone record. Example: 1

type   string     

DNS record type. Example: A

Must be one of:
  • A
  • AAAA
  • AFSDB
  • CNAME
  • DEF
  • DNAME
  • DS
  • HINFO
  • ISDN
  • LOC
  • MB
  • MD
  • MF
  • MG
  • MINFO
  • MR
  • MX
  • NAPTR
  • NS
  • PTR
  • RP
  • SOA
  • SPF
  • SRV
  • TXT
  • WKS
  • X25

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."
}

Request   

PUT api/v3/admin/dns-manager/zones/{id}/records/update

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the zone. Example: 11

Body Parameters

line   integer     

The line id of zone record. Example: 1

name   string     

The hostname or record name. Example: www

type   string     

DNS record type. Example: A

Must be one of:
  • A
  • AAAA
  • AFSDB
  • CNAME
  • DEF
  • DNAME
  • DS
  • HINFO
  • ISDN
  • LOC
  • MB
  • MD
  • MF
  • MG
  • MINFO
  • MR
  • MX
  • NAPTR
  • NS
  • PTR
  • RP
  • SOA
  • SPF
  • SRV
  • TXT
  • WKS
  • X25
ttl   integer  optional    

Time-to-live in seconds (minimum 60). Must be at least 60. Example: 3600

fields   object     

Required object for provided type. Object type one from (A, AAAA, AFSDB, CNAME, DEF, DNAME, DS, HINFO, ISDN, LOC, MB, MD, MF, MG, MINFO, MR, MX, NAPTR, NS, PTR, RP, SOA, SPF, SRV, TXT, WKS, X25).
A   object  optional    
address   string  optional    

A 32-bit IPv4 address (required if type=A). This field is required when type is A. Example: 192.0.2.1

AAAA   object  optional    
address   string  optional    

A 128-bit IPv6 address (required if type=AAAA). This field is required when type is AAAA. Example: 2001:db8::1

AFSDB   object  optional    
subtype   string  optional    

AFSDB subtype, either 1 (DFS) or 2 (DCE). This field is required when type is AFSDB. Example: 1

Must be one of:
  • 1
  • 2
hostname   string  optional    

Hostname associated with the AFSDB record. This field is required when type is AFSDB. Example: host.example.com

CNAME   object  optional    
cname   string  optional    

Canonical domain name for the alias. The owner name is the alias. This field is required when type is CNAME. Example: example.com

DEF   object  optional    
value   string  optional    

The value for the DEF record. This field is required when type is DEF. Example: Some value

DNAME   object  optional    
target   string  optional    

Target domain name to which the owner domain is aliased. This field is required when type is DNAME. Example: example.com

DS   object  optional    
keytag   integer  optional    

Key tag of the DNSKEY record this DS record refers to. This field is required when type is DS. Example: 12345

algorithm   integer  optional    

Algorithm number used by the DNSKEY. This field is required when type is DS. Example: 8

digesttype   integer  optional    

Digest type used to create the digest. This field is required when type is DS. Example: 1

digest   string  optional    

Digest of the referenced DNSKEY record. This field is required when type is DS. Example: 49FD46E6C4B45C55D4AC

HINFO   object  optional    
cpu   string  optional    

CPU type of the host machine. This field is required when type is HINFO. Example: Intel

os   string  optional    

Operating system type of the host machine. This field is required when type is HINFO. Example: Linux

ISDN   object  optional    
isdnaddress   string  optional    

ISDN address for the record (e.g., telephone number). This field is required when type is ISDN. Example: +1-555-1234567

sa   string  optional    

Subaddress associated with the ISDN address (optional). Example: 123

LOC   object  optional    
version   integer  optional    

LOC record version (optional, usually 0). Example: 0

size   number  optional    

Diameter of the sphere representing the location (optional). Example: 1

horiz_pre   number  optional    

Horizontal precision in meters (optional). Example: 100

vert_pre   number  optional    

Vertical precision in meters (optional). Example: 10

latitude   string  optional    

Latitude of the location (required if type=LOC). This field is required when type is LOC. Example: 52 22 23.0 N

longitude   string  optional    

Longitude of the location (required if type=LOC). This field is required when type is LOC. Example: 4 53 32.0 E

altitude   number  optional    

Altitude of the location in meters (optional). Example: 5

MB   object  optional    
madname   string  optional    

Domain name of the host which has the specified mailbox. This field is required when type is MB. Example: mail.example.com

MD   object  optional    
madname   string  optional    

Domain name of the host which has a mail agent for the domain. This field is required when type is MD. Example: mail.example.com

MF   object  optional    
madname   string  optional    

Domain name of the host which has a mail agent for forwarding mail to the domain. This field is required when type is MF. Example: forwarder.example.com

MG   object  optional    
mgmname   string  optional    

Domain name of the mailbox which is a member of the mail group. This field is required when type is MG. Example: member.example.com

MINFO   object  optional    
rmailbx   string  optional    

Mailbox responsible for the mailing list or mailbox. This field is required when type is MINFO. Example: responsible.example.com

emailbx   string  optional    

Mailbox to receive error messages related to the mailing list or mailbox. This field is required when type is MINFO. Example: [email protected]

MR   object  optional    
newname   string  optional    

Mailbox which is the proper rename of the specified mailbox. This field is required when type is MR. Example: newmail.example.com

MX   object  optional    
preference   integer  optional    

Preference value for the mail exchange; lower values are preferred. This field is required when type is MX. Must be at least 0. Must not be greater than 65535. Example: 10

exchange   string  optional    

Domain name of the host willing to act as a mail exchange for the owner. This field is required when type is MX. Example: mail.example.com

NAPTR   object  optional    
order   integer  optional    

Order in which the NAPTR record is processed. This field is required when type is NAPTR. Must be at least 0. Example: 100

preference   integer  optional    

Preference for records with the same order; lower values are preferred. This field is required when type is NAPTR. Must be at least 0. Example: 10

flags   string  optional    

Flags controlling the rewriting and interpretation of the record. This field is required when type is NAPTR. Example: U

services   string  optional    

Services available via this NAPTR record (e.g., E2U+sip). This field is required when type is NAPTR. Example: E2U+sip

regexp   string  optional    

Regular expression used to rewrite the original string (optional). Example: !^.*$!sip:[email protected]!

replacement   string  optional    

Replacement domain name if the regexp is not used. This field is required when type is NAPTR. Example: example.com

NS   object  optional    
nsdname   string  optional    

Domain name of the host which should be authoritative for the domain. This field is required when type is NS. Example: ns1.example.com

PTR   object  optional    
ptrdname   string  optional    

Domain name that the PTR record points to in the DNS namespace. This field is required when type is PTR. Example: host.example.com

RP   object  optional    
mbox   string  optional    

Mailbox responsible for the domain or owner. This field is required when type is RP. Example: admin.example.com

txtdname   string  optional    

Domain name containing additional text information. This field is required when type is RP. Example: info.example.com

SOA   object  optional    
mname   string  optional    

Primary name server for the zone. This field is required when type is SOA. Example: ns1.example.com

rname   string  optional    

Mailbox of the person responsible for the zone. This field is required when type is SOA. Example: admin.example.com

serial   integer  optional    

Serial number of the zone; incremented on changes. This field is required when type is SOA. Must be at least 0. Example: 2025090901

refresh   integer  optional    

Time interval before the zone should be refreshed (seconds). This field is required when type is SOA. Must be at least 0. Example: 3600

retry   integer  optional    

Time interval before a failed refresh should be retried (seconds). This field is required when type is SOA. Must be at least 0. Example: 1800

expire   integer  optional    

Time interval before the zone is no longer authoritative (seconds). This field is required when type is SOA. Must be at least 0. Example: 604800

minimum   integer  optional    

Minimum TTL for records in this zone (seconds). This field is required when type is SOA. Must be at least 0. Example: 86400

SPF   object  optional    
txtdata   string  optional    

SPF record data specifying allowed sending hosts for the domain. This field is required when type is SPF. Example: "v=spf1 include:example.com ~all"

SRV   object  optional    
priority   integer  optional    

Priority of the target host; lower values are preferred. This field is required when type is SRV. Must be at least 0. Example: 10

weight   integer  optional    

Relative weight for records with the same priority. This field is required when type is SRV. Must be at least 0. Example: 5

port   integer  optional    

Port on which the service is running (0-65535). This field is required when type is SRV. Must be at least 0. Must not be greater than 65535. Example: 5060

target   string  optional    

Domain name of the target host providing the service. This field is required when type is SRV. Example: sip.example.com

TXT   object  optional    
txtdata   string  optional    

Text data for the TXT record; one or more character strings. This field is required when type is TXT. Example: "v=spf1 include:example.com ~all"

WKS   object  optional    
address   string  optional    

32-bit IPv4 address. This field is required when type is WKS. Example: 192.0.2.1

protocol   integer  optional    

8-bit IP protocol number. This field is required when type is WKS. Must be at least 0. Must not be greater than 255. Example: 6

bitmap   string  optional    

Variable length bitmap; must be a multiple of 8 bits. This field is required when type is WKS. Example: 0101010100000000

X25   object  optional    
psdnaddress   string  optional    

Public Switched Data Network (PSDN) address. This field is required when type is X25. Example: 1234567890

Password Manager

List access details

requires authentication

This endpoint returns a paginated collection of access details

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/pm/access?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/pm/access'
params = {
  'per_page': '10',
  'page': '1',
  'sort_by': 'id',
  'sort_dir': 'asc',
  'search_term': 'active,pending',
  'search_op': 'like',
  'search_fields': 'name',
}
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/pm/access';
$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' => 'name',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 111,
            "name": "ullam quod quisquam",
            "owner_id": 9973,
            "device_id": 1737,
            "username": "uprosacco",
            "password": "secret123",
            "website": "mraz.com",
            "login_url": "http://hansen.com/molestiae-sunt-ab-nemo-facilis",
            "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQe5a30dac1f75d202d0865eb883568462e464e682",
            "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\n50eef453b71ee17ab457d9fbb6314612a59788f6917aad5db4cb48ca33c570c7\n-----END PRIVATE KEY-----",
            "notes": "Quis nemo eos aut dolor.",
            "created_at": "2025-11-12 09:10:25",
            "updated_at": "2025-11-12 09:10:25"
        },
        {
            "id": 112,
            "name": "numquam blanditiis eum",
            "owner_id": 9981,
            "device_id": 1738,
            "username": "oboehm",
            "password": "secret123",
            "website": "rowe.info",
            "login_url": "http://www.wunsch.info/",
            "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQa725be837a4481f26df6ca5f2c289f1d436efecc",
            "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\nd4016def408e6e10b41046e84e69049d5655b2882597fc4ae780b4d5ff06c59c\n-----END PRIVATE KEY-----",
            "notes": "Cum natus veritatis rem in.",
            "created_at": "2025-11-12 09:10:26",
            "updated_at": "2025-11-12 09:10:26"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://your-easydcim.com/api/v3/admin/pm/access?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://your-easydcim.com/api/v3/admin/pm/access",
        "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."
}

Request   

GET api/v3/admin/pm/access

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, owner_id, device_id, username, password, website, login_url. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: name, owner_id, device_id, username, password, website, login_url. Example: name

Show Access Detail

requires authentication

Returns detailed information about access detail.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/pm/access/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/pm/access/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/pm/access/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": 113,
        "name": "quae et pariatur",
        "owner_id": 9989,
        "device_id": 1739,
        "username": "lance69",
        "password": "secret123",
        "website": "kemmer.org",
        "login_url": "http://feeney.com/",
        "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQcd953d60d7ab20d05f03f25e80eb2c0dcf01d520",
        "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\n3d3a64e041ef1bb3a73777c76259b609ff2f2f12bc55969538fa8397eb6cb262\n-----END PRIVATE KEY-----",
        "notes": "Ut recusandae eius placeat ut perspiciatis ut.",
        "created_at": "2025-11-12 09:10:26",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

GET api/v3/admin/pm/access/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the access detail. Example: 1

Create Access Detail

requires authentication

Creates a new access detail with the provided details.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/pm/access" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Production Database Access\",
    \"username\": \"db_admin\",
    \"password\": \"S3cur3P@ssw0rd!\",
    \"owner_id\": 42,
    \"device_id\": 101,
    \"website\": \"example.com\",
    \"login_url\": \"https:\\/\\/login.example.com\",
    \"public_ssh_keys\": \"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...\",
    \"private_ssh_keys\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\\\n...\",
    \"notes\": \"This account is used for nightly backups only.\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/pm/access'
payload = {
    "name": "Production Database Access",
    "username": "db_admin",
    "password": "S3cur3P@ssw0rd!",
    "owner_id": 42,
    "device_id": 101,
    "website": "example.com",
    "login_url": "https:\/\/login.example.com",
    "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...",
    "private_ssh_keys": "-----BEGIN OPENSSH PRIVATE KEY-----\\n...",
    "notes": "This account is used for nightly backups only."
}
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/pm/access';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Production Database Access',
            'username' => 'db_admin',
            'password' => 'S3cur3P@ssw0rd!',
            'owner_id' => 42,
            'device_id' => 101,
            'website' => 'example.com',
            'login_url' => 'https://login.example.com',
            'public_ssh_keys' => 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...',
            'private_ssh_keys' => '-----BEGIN OPENSSH PRIVATE KEY-----\\n...',
            'notes' => 'This account is used for nightly backups only.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 114,
        "name": "sit omnis alias",
        "owner_id": 9997,
        "device_id": 1740,
        "username": "feeney.reva",
        "password": "secret123",
        "website": "schowalter.com",
        "login_url": "http://halvorson.biz/",
        "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ0bfd7005b1b343a4d57a94d08577e374b0125652",
        "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\n803316fecf0b21fbb64824b3fff9c8e8a7afab526a6a10b62add1bb7bf5ea60e\n-----END PRIVATE KEY-----",
        "notes": "Non voluptates deserunt quisquam unde qui sed.",
        "created_at": "2025-11-12 09:10:27",
        "updated_at": "2025-11-12 09:10:27"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/pm/access

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

A descriptive name for the credential or access detail. Example: Production Database Access

username   string     

The username associated with the access detail. Example: db_admin

password   string     

The password associated with the username. Example: S3cur3P@ssw0rd!

owner_id   integer  optional    

The ID of the user who owns this credential. Example: 42

device_id   integer  optional    

The ID of the device this credential is associated with. Example: 101

website   string  optional    

The website or domain related to the access detail. Example: example.com

login_url   string  optional    

The direct login URL related to the access detail. Example: https://login.example.com

public_ssh_keys   string  optional    

Public SSH keys associated with the access detail. Example: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...

private_ssh_keys   string  optional    

Private SSH keys associated with the access detail. Example: -----BEGIN OPENSSH PRIVATE KEY-----\n...

notes   string  optional    

Additional notes or comments regarding the access detail. Example: This account is used for nightly backups only.

Update Access detail

requires authentication

Updates access detail with the provided details and id.

Example request:
curl --request PUT \
    "https://your-easydcim.com/api/v3/admin/pm/access/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Production Database Access\",
    \"username\": \"db_admin\",
    \"password\": \"S3cur3P@ssw0rd!\",
    \"owner_id\": 42,
    \"device_id\": 101,
    \"website\": \"example.com\",
    \"login_url\": \"https:\\/\\/login.example.com\",
    \"public_ssh_keys\": \"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...\",
    \"private_ssh_keys\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\\\n...\",
    \"notes\": \"This account is used for nightly backups only.\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/pm/access/1'
payload = {
    "name": "Production Database Access",
    "username": "db_admin",
    "password": "S3cur3P@ssw0rd!",
    "owner_id": 42,
    "device_id": 101,
    "website": "example.com",
    "login_url": "https:\/\/login.example.com",
    "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...",
    "private_ssh_keys": "-----BEGIN OPENSSH PRIVATE KEY-----\\n...",
    "notes": "This account is used for nightly backups only."
}
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/pm/access/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Production Database Access',
            'username' => 'db_admin',
            'password' => 'S3cur3P@ssw0rd!',
            'owner_id' => 42,
            'device_id' => 101,
            'website' => 'example.com',
            'login_url' => 'https://login.example.com',
            'public_ssh_keys' => 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...',
            'private_ssh_keys' => '-----BEGIN OPENSSH PRIVATE KEY-----\\n...',
            'notes' => 'This account is used for nightly backups only.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 115,
        "name": "fugit libero reiciendis",
        "owner_id": 10005,
        "device_id": 1741,
        "username": "sfeeney",
        "password": "secret123",
        "website": "hettinger.org",
        "login_url": "http://www.ebert.com/",
        "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ02959f07e9e44ed71b473382521cfaaea12a2253",
        "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\n5e3a61703ae9a50a4c5e66e9edb6d3acdc6b5db5ea38e8f62f3294c77b254690\n-----END PRIVATE KEY-----",
        "notes": "Dicta fuga et maxime maxime soluta.",
        "created_at": "2025-11-12 09:10:27",
        "updated_at": "2025-11-12 09:10:27"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/pm/access/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the access detail. Example: 1

Body Parameters

name   string     

A descriptive name for the credential or access detail. Example: Production Database Access

username   string     

The username associated with the access detail. Example: db_admin

password   string     

The password associated with the username. Example: S3cur3P@ssw0rd!

owner_id   integer  optional    

The ID of the user who owns this credential. Example: 42

device_id   integer  optional    

The ID of the device this credential is associated with. Example: 101

website   string  optional    

The website or domain related to the access detail. Example: example.com

login_url   string  optional    

The direct login URL related to the access detail. Example: https://login.example.com

public_ssh_keys   string  optional    

Public SSH keys associated with the access detail. Example: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...

private_ssh_keys   string  optional    

Private SSH keys associated with the access detail. Example: -----BEGIN OPENSSH PRIVATE KEY-----\n...

notes   string  optional    

Additional notes or comments regarding the access detail. Example: This account is used for nightly backups only.

Delete Access Detail

requires authentication

Deletes access detail with given id

Example request:
curl --request DELETE \
    "https://your-easydcim.com/api/v3/admin/pm/access/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/pm/access/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/pm/access/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."
}

Request   

DELETE api/v3/admin/pm/access/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the access detail. Example: 1

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": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/usage-collector/limits

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, label, location_id, type_id, model_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, label, location_id, type_id, model_id. Example: id

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."
}

Request   

GET api/v3/admin/usage-collector/{id}/limits

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Update Limits For Device

requires authentication

Returns limits for device

Example request:
curl --request PUT \
    "https://your-easydcim.com/api/v3/admin/usage-collector/1/limits" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit_type\": \"TrafficAggregation\",
    \"config\": {
        \"bandwidth\": 100,
        \"bandwidth_unit\": \"GB\",
        \"bandwidth_in\": 100,
        \"bandwidth_in_unit\": \"MB\",
        \"bandwidth_out\": 100,
        \"bandwidth_out_unit\": \"TB\",
        \"percentile\": null,
        \"disable_traffic_aggregation_ports\": false,
        \"interval_start_day\": \"first day of this month\",
        \"enable_notifications\": false,
        \"time_unit\": 5,
        \"warning_notification_treshold\": 110
    }
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits'
payload = {
    "limit_type": "TrafficAggregation",
    "config": {
        "bandwidth": 100,
        "bandwidth_unit": "GB",
        "bandwidth_in": 100,
        "bandwidth_in_unit": "MB",
        "bandwidth_out": 100,
        "bandwidth_out_unit": "TB",
        "percentile": null,
        "disable_traffic_aggregation_ports": false,
        "interval_start_day": "first day of this month",
        "enable_notifications": false,
        "time_unit": 5,
        "warning_notification_treshold": 110
    }
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/usage-collector/1/limits';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'limit_type' => 'TrafficAggregation',
            'config' => [
                'bandwidth' => 100,
                'bandwidth_unit' => 'GB',
                'bandwidth_in' => 100,
                'bandwidth_in_unit' => 'MB',
                'bandwidth_out' => 100,
                'bandwidth_out_unit' => 'TB',
                'percentile' => null,
                'disable_traffic_aggregation_ports' => false,
                'interval_start_day' => 'first day of this month',
                'enable_notifications' => false,
                'time_unit' => 5,
                'warning_notification_treshold' => 110,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 111,
        "label": "4U",
        "model": "Generic",
        "device_status": "running",
        "location": "Rzeszow",
        "metadata": [],
        "configurations": [
            {
                "id": 2,
                "driver": "PowerUsage",
                "enabled": false,
                "config": {
                    "total": "12",
                    "interval_start_day": "first day of this month",
                    "enable_notifications": "0",
                    "time_unit": "5",
                    "warning_notification_treshold": "110"
                },
                "created_at": "2025-08-20 12:18:41",
                "updated_at": "2025-08-20 12:18:41"
            },
            {
                "id": 3,
                "driver": "TrafficAggregation",
                "enabled": false,
                "config": {
                    "bandwidth": "1000",
                    "bandwidth_unit": "MB",
                    "bandwidth_in": "200",
                    "bandwidth_in_unit": "MB",
                    "bandwidth_out": "300",
                    "bandwidth_out_unit": "TB",
                    "percentile": null,
                    "disable_traffic_aggregation_ports": "0",
                    "interval_start_day": "first day of this month",
                    "enable_notifications": "0",
                    "time_unit": "5",
                    "warning_notification_treshold": "110"
                },
                "created_at": "2025-08-20 12:24:26",
                "updated_at": "2025-08-20 12:24:26"
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/usage-collector/{id}/limits

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

limit_type   string     

Limit Type for which configuration should be updated. TrafficAggregation for item types: Server, Blade, Colocation, PDU, Switch, Router, Firewall, PowerUsage for item types: PDU, Colocation and ServerPowerUsage for item types: Server, Blade. Example: TrafficAggregation

Must be one of:
  • PowerUsage
  • ServerPowerUsage
  • TrafficAggregation
config   object     

Configuration properties to be updated.

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."
}

Request   

DELETE api/v3/admin/usage-collector/{id}/limits

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

limit_type   string     

Limit Type for which configuration should be updated. TrafficAggregation for item types: Server, Blade, Colocation, PDU, Switch, Router, Firewall, PowerUsage for item types: PDU, Colocation and ServerPowerUsage for item types: Server, Blade. Example: TrafficAggregation

Must be one of:
  • PowerUsage
  • ServerPowerUsage
  • TrafficAggregation

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": 244,
            "pool": "245.135.6.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Pariatur qui beatae est eaque necessitatibus.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        },
        {
            "id": 245,
            "pool": "28.18.3.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Mollitia nobis omnis non recusandae.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipam/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id. Example: mask

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": 246,
        "pool": "141.126.210.0",
        "mask": 24,
        "type": "ipv4",
        "status": "available",
        "ns1": null,
        "ns2": null,
        "gateway": null,
        "is_master_pool": 0,
        "description": "Nihil porro possimus nihil qui officiis possimus.",
        "assignment": false,
        "tenants": [],
        "children": [],
        "parent": null,
        "vlan": null,
        "ip_addresses": {
            "assigned_ips": [],
            "available_ranges": [
                {
                    "start": "141.126.210.1",
                    "end": "141.126.210.254"
                }
            ]
        },
        "addressing": {
            "network_address": "141.126.210.0",
            "network_mask": "255.255.255.0",
            "wildcard_mask": "0.0.0.255",
            "broadcast_address": "141.126.210.255",
            "first_available_ip": "141.126.210.1",
            "utilization_percentage": 0,
            "available_ips": 254,
            "assigned_ips": 0,
            "free_ips": 254
        },
        "created_at": "2025-11-12 09:10:28",
        "updated_at": "2025-11-12 09:10:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/ipam/subnets/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the subnet. Example: 1

Create Subnet

requires authentication

Creates a new subnet with the provided details.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/ipam/subnets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pool\": \"192.168.56.100\",
    \"mask\": 32,
    \"type\": \"ipv4\",
    \"description\": \"This is the description\",
    \"status\": \"available\",
    \"is_master_pool\": 1,
    \"parent_id\": 1,
    \"vlan_id\": 2,
    \"tenant_type\": \"Modules\\\\Addons\\\\IPManager\\\\Model\\\\IpamDevice\",
    \"tenant_ids\": [
        1
    ],
    \"assignment\": [
        \"location_1\"
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets'
payload = {
    "pool": "192.168.56.100",
    "mask": 32,
    "type": "ipv4",
    "description": "This is the description",
    "status": "available",
    "is_master_pool": 1,
    "parent_id": 1,
    "vlan_id": 2,
    "tenant_type": "Modules\\Addons\\IPManager\\Model\\IpamDevice",
    "tenant_ids": [
        1
    ],
    "assignment": [
        "location_1"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pool' => '192.168.56.100',
            'mask' => 32,
            'type' => 'ipv4',
            'description' => 'This is the description',
            'status' => 'available',
            'is_master_pool' => 1,
            'parent_id' => 1,
            'vlan_id' => 2,
            'tenant_type' => 'Modules\\Addons\\IPManager\\Model\\IpamDevice',
            'tenant_ids' => [
                1,
            ],
            'assignment' => [
                'location_1',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 247,
        "pool": "15.195.30.0",
        "mask": 24,
        "type": "ipv4",
        "status": "available",
        "ns1": null,
        "ns2": null,
        "gateway": null,
        "is_master_pool": 0,
        "description": "Molestiae sint sunt nam natus placeat.",
        "assignment": false,
        "tenants": [],
        "children": [],
        "parent": null,
        "vlan": null,
        "ip_addresses": {
            "assigned_ips": [],
            "available_ranges": [
                {
                    "start": "15.195.30.1",
                    "end": "15.195.30.254"
                }
            ]
        },
        "addressing": {
            "network_address": "15.195.30.0",
            "network_mask": "255.255.255.0",
            "wildcard_mask": "0.0.0.255",
            "broadcast_address": "15.195.30.255",
            "first_available_ip": "15.195.30.1",
            "utilization_percentage": 0,
            "available_ips": 254,
            "assigned_ips": 0,
            "free_ips": 254
        },
        "created_at": "2025-11-12 09:10:28",
        "updated_at": "2025-11-12 09:10:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/ipam/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

pool   string     

The pool of the subnet. Must be a valid IP address. Example: 192.168.56.100

mask   integer     

The mask of the subnet (Integer between 1-32 for ipv4 or 1-128 for ipv6). Must be between 0 and 128. Example: 32

type   string     

The type of the subnet. Example: ipv4

Must be one of:
  • ipv4
  • ipv6
description   string  optional    

The description of the subnet. Example: This is the description

status   string  optional    

The status of the subnet. Example: available

Must be one of:
  • available
  • active
  • disabled
  • reserved
is_master_pool   integer  optional    

Leave empty if it is not a master pool. Must be between 0 and 1. Example: 1

parent_id   integer  optional    

The parent ID for which subnet should be created. Example: 1

vlan_id   integer  optional    

The VLAN ID that should be assigned to the subnet. Example: 2

tenant_type   string  optional    

The tenant type of the tenant ids. Example: Modules\Addons\IPManager\Model\IpamDevice

Must be one of:
  • Modules\Addons\IPManager\Model\IpamDevice
  • Modules\Addons\IPManager\Model\IpamUser
tenant_ids   integer[]  optional    

The tenants that should be assigned to subnet. Tenant type must be provided for tenant ids to be assigned correctly.

assignment   string[]  optional    

Optionally restrict the subnet to specific infrastructure locations (e.g., location_{locationid}, floor{floorid}, rack{rack_id}). Leave this field empty to apply the subnet globally across all sites.

Update Subnet

requires authentication

Updates subnet with the provided details and id.

Example request:
curl --request PUT \
    "https://your-easydcim.com/api/v3/admin/ipam/subnets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"This is the description\",
    \"status\": \"available\",
    \"is_master_pool\": 1,
    \"parent_id\": 1,
    \"vlan_id\": 2,
    \"tenant_type\": \"Modules\\\\Addons\\\\IPManager\\\\Model\\\\IpamDevice\",
    \"tenant_ids\": [
        1
    ],
    \"assignment\": [
        \"location_1\"
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1'
payload = {
    "description": "This is the description",
    "status": "available",
    "is_master_pool": 1,
    "parent_id": 1,
    "vlan_id": 2,
    "tenant_type": "Modules\\Addons\\IPManager\\Model\\IpamDevice",
    "tenant_ids": [
        1
    ],
    "assignment": [
        "location_1"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/subnets/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'This is the description',
            'status' => 'available',
            'is_master_pool' => 1,
            'parent_id' => 1,
            'vlan_id' => 2,
            'tenant_type' => 'Modules\\Addons\\IPManager\\Model\\IpamDevice',
            'tenant_ids' => [
                1,
            ],
            'assignment' => [
                'location_1',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 248,
        "pool": "70.118.66.0",
        "mask": 24,
        "type": "ipv4",
        "status": "available",
        "ns1": null,
        "ns2": null,
        "gateway": null,
        "is_master_pool": 0,
        "description": "Vero eos et nam voluptatem.",
        "assignment": false,
        "tenants": [],
        "children": [],
        "parent": null,
        "vlan": null,
        "ip_addresses": {
            "assigned_ips": [],
            "available_ranges": [
                {
                    "start": "70.118.66.1",
                    "end": "70.118.66.254"
                }
            ]
        },
        "addressing": {
            "network_address": "70.118.66.0",
            "network_mask": "255.255.255.0",
            "wildcard_mask": "0.0.0.255",
            "broadcast_address": "70.118.66.255",
            "first_available_ip": "70.118.66.1",
            "utilization_percentage": 0,
            "available_ips": 254,
            "assigned_ips": 0,
            "free_ips": 254
        },
        "created_at": "2025-11-12 09:10:28",
        "updated_at": "2025-11-12 09:10:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

PUT api/v3/admin/ipam/subnets/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the subnet. Example: 1

Body Parameters

description   string  optional    

The description of the subnet. Example: This is the description

status   string  optional    

The status of the subnet. Example: available

Must be one of:
  • available
  • active
  • disabled
  • reserved
is_master_pool   integer  optional    

Leave empty if it is not a master pool. Must be between 0 and 1. Example: 1

parent_id   integer  optional    

The parent ID for which subnet should be created. Example: 1

vlan_id   integer  optional    

The VLAN ID that should be assigned to the subnet. Example: 2

tenant_type   string  optional    

The tenant type of the tenant ids. Example: Modules\Addons\IPManager\Model\IpamDevice

Must be one of:
  • Modules\Addons\IPManager\Model\IpamDevice
  • Modules\Addons\IPManager\Model\IpamUser
tenant_ids   integer[]  optional    

The tenants that should be assigned to subnet. Tenant type must be provided for tenant ids to be assigned correctly.

assignment   string[]  optional    

Optionally restrict the subnet to specific infrastructure locations (e.g., location_{locationid}, floor{floorid}, rack{rack_id}). Leave this field empty to apply the subnet globally across all sites.

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": 249,
        "pool": "141.76.193.0",
        "mask": 24,
        "type": "ipv4",
        "status": "available",
        "ns1": null,
        "ns2": null,
        "gateway": null,
        "is_master_pool": 0,
        "description": "Facilis officia sunt alias necessitatibus consequatur modi.",
        "assignment": false,
        "tenants": [],
        "children": [],
        "parent": null,
        "vlan": null,
        "ip_addresses": {
            "assigned_ips": [],
            "available_ranges": [
                {
                    "start": "141.76.193.1",
                    "end": "141.76.193.254"
                }
            ]
        },
        "addressing": {
            "network_address": "141.76.193.0",
            "network_mask": "255.255.255.0",
            "wildcard_mask": "0.0.0.255",
            "broadcast_address": "141.76.193.255",
            "first_available_ip": "141.76.193.1",
            "utilization_percentage": 0,
            "available_ips": 254,
            "assigned_ips": 0,
            "free_ips": 254
        },
        "created_at": "2025-11-12 09:10:28",
        "updated_at": "2025-11-12 09:10:28"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/ipam/subnets/{id}/split

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the subnet. Example: 1

Body Parameters

selected_mask   integer     

The mask of the subnets created after split greater than parent subnet (Integer between 1-32 for ipv4 or 1-128 for ipv6). Must be between 0 and 128. Example: 32

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."
}

Request   

DELETE api/v3/admin/ipam/subnets/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the subnet. Example: 1

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": 250,
            "pool": "61.98.42.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Et corporis non ut saepe.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        },
        {
            "id": 251,
            "pool": "100.152.133.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Accusamus quibusdam maxime vitae nobis quia.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipam/user/{id}/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 1

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id. Example: mask

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": 252,
            "pool": "70.17.61.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Aut quae molestiae illo in.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        },
        {
            "id": 253,
            "pool": "131.95.83.0",
            "mask": 24,
            "type": "ipv4",
            "status": "available",
            "ns1": null,
            "ns2": null,
            "gateway": null,
            "is_master_pool": 0,
            "description": "Laudantium et eaque non ipsum.",
            "assignment": false,
            "tenants": [],
            "children": [],
            "parent": null,
            "vlan": null,
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipam/device/{id}/subnets

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id. Example: mask

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": 1744,
        "label": "optio",
        "model": "enim",
        "product_id": 0,
        "model_id": 2583,
        "parent_id": 0,
        "type_id": 3131,
        "user_id": 10030,
        "order_id": 1115,
        "location_id": 5682,
        "rack_id": 1008,
        "blade_id": 0,
        "os_installation": 0,
        "colocation_id": 0,
        "provisioning_id": 0,
        "device_status": "running",
        "service_status": "activated",
        "location": "Hirthe, Huels and Gibson",
        "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=\"text-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."
}

Request   

POST api/v3/admin/ipam/device/{id}/subnets/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

subnets   integer[]  optional    

The array of subnets.

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": 1745,
        "label": "sint",
        "model": "porro",
        "product_id": 0,
        "model_id": 2584,
        "parent_id": 0,
        "type_id": 3133,
        "user_id": 10037,
        "order_id": 1116,
        "location_id": 5686,
        "rack_id": 1009,
        "blade_id": 0,
        "os_installation": 0,
        "colocation_id": 0,
        "provisioning_id": 0,
        "device_status": "running",
        "service_status": "activated",
        "location": "Rowe-Wiegand",
        "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=\"text-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."
}

Request   

POST api/v3/admin/ipam/device/{id}/subnets/unassign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the device. Example: 1

Body Parameters

subnets   integer[]  optional    

The array of subnets.

List of IP addresses

requires authentication

This endpoint returns a paginated collection of IP addresses

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/ipam/ips?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=value" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/ipam/ips'
params = {
  'per_page': '10',
  'page': '1',
  'sort_by': 'id',
  'sort_dir': 'asc',
  'search_term': 'active,pending',
  'search_op': 'like',
  'search_fields': 'value',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/admin/ipam/ips';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '10',
            'page' => '1',
            'sort_by' => 'id',
            'sort_dir' => 'asc',
            'search_term' => 'active,pending',
            'search_op' => 'like',
            'search_fields' => 'value',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 265,
            "item_id": 38,
            "value": "200.94.209.231",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 307,
            "item_id": 44,
            "value": "146.224.170.224",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 314,
            "item_id": 45,
            "value": "139.235.236.138",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 328,
            "item_id": 47,
            "value": "207.243.68.21",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 335,
            "item_id": 48,
            "value": "46.236.68.242",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 342,
            "item_id": 49,
            "value": "166.73.24.58",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 356,
            "item_id": 51,
            "value": "160.24.83.37",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 363,
            "item_id": 52,
            "value": "80.24.122.22",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 370,
            "item_id": 53,
            "value": "174.251.45.79",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 377,
            "item_id": 54,
            "value": "155.150.252.1",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        }
    ],
    "links": {
        "first": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
        "last": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
        "prev": null,
        "next": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 16,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipam/ips

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, value, description, type, ip_type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: value, description, type, ip_type. Example: value

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."
}

Request   

PUT api/v3/admin/ipam/ips/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the IP address entity. Example: 456

Body Parameters

description   string  optional    

Description or label for the IP address. Example: Primary IP for web server

ip_address   string     

IP Address for which description will be updated. Example: 192.168.56.1

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": 97,
            "device_id": null,
            "vlan_vlan": 880,
            "vlan_name": "aliquid repudiandae",
            "description": "Nemo voluptatem nobis aut sequi eum rerum eveniet.",
            "vlan_type": "standard",
            "vlan_status": "depreciated",
            "device": null
        },
        {
            "id": 98,
            "device_id": null,
            "vlan_vlan": 528,
            "vlan_name": "nihil omnis",
            "description": "Enim odio impedit iure qui eum.",
            "vlan_type": "provisioning",
            "vlan_status": "reserved",
            "device": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/admin/ipam/vlans

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, vlan_vlan, vlan_name, vlan_type, vlan_status, description, device_id. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: vlan_vlan, vlan_name, vlan_type, vlan_status, description, device_id. Example: vlan_vlan

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": 99,
        "device_id": null,
        "vlan_vlan": 199,
        "vlan_name": "aut laborum",
        "description": "Qui eius rerum expedita ratione eius reiciendis sed.",
        "vlan_type": "standard",
        "vlan_status": "active",
        "device": null,
        "ports": []
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/ipam/vlans/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the vlan. Example: 1

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": 100,
        "device_id": null,
        "vlan_vlan": 3194,
        "vlan_name": "reprehenderit ullam",
        "description": "Dolore sapiente aliquam tempore optio excepturi cum quae dolor.",
        "vlan_type": "standard",
        "vlan_status": "reserved",
        "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."
}

Request   

POST api/v3/admin/ipam/vlans

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

device_id   integer     

Device Id for which vlan should be created. Example: 1

vlan_vlan   integer     

The id of the vlan. Example: 1001

vlan_name   string     

The name of the vlan. Example: VLAN 1001

vlan_type   string  optional    

The type of the vlan. Example: standard

Must be one of:
  • standard
  • provisioning
status   string  optional    

The status of the vlan. Example: active

Must be one of:
  • active
  • reserved
  • depreciated
description   string  optional    

The description of the vlan. Example: This is the description of the vlan.

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": 101,
        "device_id": null,
        "vlan_vlan": 1323,
        "vlan_name": "autem ut",
        "description": "Molestias doloremque iure sunt dolorum quae rem.",
        "vlan_type": "provisioning",
        "vlan_status": "reserved",
        "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."
}

Request   

PUT api/v3/admin/ipam/vlans/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the vlan. Example: 1

Body Parameters

vlan_type   string  optional    

The type of the vlan. Example: standard

Must be one of:
  • standard
  • provisioning
status   string  optional    

The status of the vlan. Example: active

Must be one of:
  • active
  • reserved
  • depreciated
description   string  optional    

The description of the vlan. Example: This is the description of the vlan.

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."
}

Request   

DELETE api/v3/admin/ipam/vlans/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the vlan. Example: 1

Tags

List Tags

requires authentication

Returns a paginated list of tags.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/tags?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/tags'
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/tags';
$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": 100,
            "name": "similique",
            "color": "#fbec15",
            "type": "App\\Models\\User",
            "created_at": "2025-11-12 09:10:29",
            "updated_at": "2025-11-12 09:10:29"
        },
        {
            "id": 101,
            "name": "quae",
            "color": "#036c29",
            "type": "App\\Models\\User",
            "created_at": "2025-11-12 09:10:29",
            "updated_at": "2025-11-12 09:10:29"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://your-easydcim.com/api/v3/admin/tags?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://your-easydcim.com/api/v3/admin/tags",
        "per_page": 10,
        "to": 1,
        "total": 2,
        "sort_by": "",
        "sort_dir": null
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

GET api/v3/admin/tags

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, type. Example: id

Show tag

requires authentication

Display detailed information about a single tag by its ID.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/admin/tags/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/tags/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/tags/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": 102,
        "name": "eos",
        "color": "#f05562",
        "type": "App\\Models\\User",
        "assignedTo": [],
        "created_at": "2025-11-12 09:10:29",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

GET api/v3/admin/tags/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the tag. Example: 1

Create tag

requires authentication

Store a new tag in the system using validated request data.

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Server\",
    \"color\": \"#FA6900\",
    \"type\": \"App\\\\Models\\\\Item\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/tags'
payload = {
    "name": "Server",
    "color": "#FA6900",
    "type": "App\\Models\\Item"
}
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/tags';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Server',
            'color' => '#FA6900',
            'type' => 'App\\Models\\Item',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 103,
        "name": "porro",
        "color": "#f1336b",
        "type": "App\\Models\\User",
        "assignedTo": [],
        "created_at": "2025-11-12 09:10:29",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

POST api/v3/admin/tags

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The name of the tag. Example: Server

color   string     

The color of the tag. Example: #FA6900

type   string     

The type of the tag. Example: App\Models\Item

Must be one of:
  • App\Models\Colocation
  • App\Models\Device
  • App\Models\Item
  • App\Models\ItemPort
  • App\Models\ItemSensor
  • App\Models\ItemVlan
  • App\Models\Order
  • App\Models\User
  • Modules\Addons\IPManager\Model\IpamSubnet

Update tag

requires authentication

Updates the specified tag with provided data.

Example request:
curl --request PUT \
    "https://your-easydcim.com/api/v3/admin/tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Server\",
    \"color\": \"#FA6900\"
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/tags/1'
payload = {
    "name": "Server",
    "color": "#FA6900"
}
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/tags/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Server',
            'color' => '#FA6900',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 104,
        "name": "repudiandae",
        "color": "#b6dadd",
        "type": "App\\Models\\User",
        "assignedTo": [],
        "created_at": "2025-11-12 09:10:29",
        "updated_at": "2025-11-12 09:10: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."
}

Request   

PUT api/v3/admin/tags/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the tag. Example: 1

Body Parameters

name   string  optional    

The name of the tag. Example: Server

color   string  optional    

The color of the tag. Example: #FA6900

Delete tag

requires authentication

Removes the specified tag from the system.

Example request:
curl --request DELETE \
    "https://your-easydcim.com/api/v3/admin/tags/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/tags/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/tags/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."
}

Request   

DELETE api/v3/admin/tags/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the tag. Example: 5

Assign multiple tags to specified entity

requires authentication

Assigns multiple tags to specified entity

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/tags/assign" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"entity_id\": 1,
    \"entity_type\": \"App\\\\Models\\\\Item\",
    \"tags\": [
        1
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/tags/assign'
payload = {
    "entity_id": 1,
    "entity_type": "App\\Models\\Item",
    "tags": [
        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/tags/assign';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'entity_id' => 1,
            'entity_type' => 'App\\Models\\Item',
            'tags' => [
                1,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 38,
        "tags": [
            {
                "id": 3,
                "name": "For Sale",
                "color": "#c70000",
                "type": "App\\Models\\Device"
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/tags/assign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

entity_id   integer     

The id of the entity. Example: 1

entity_type   string     

The type of the tag. Example: App\Models\Item

Must be one of:
  • App\Models\Colocation
  • App\Models\Device
  • App\Models\Item
  • App\Models\ItemPort
  • App\Models\ItemSensor
  • App\Models\ItemVlan
  • App\Models\Order
  • App\Models\User
  • Modules\Addons\IPManager\Model\IpamSubnet
tags   integer[]  optional    

Array of tags ids. The id of an existing record in the tags table.

Unassign multiple tags from specified entity

requires authentication

Unassigns multiple tags from specified entity

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/admin/tags/unassign" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"entity_id\": 1,
    \"entity_type\": \"App\\\\Models\\\\Item\",
    \"tags\": [
        1
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/admin/tags/unassign'
payload = {
    "entity_id": 1,
    "entity_type": "App\\Models\\Item",
    "tags": [
        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/tags/unassign';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'entity_id' => 1,
            'entity_type' => 'App\\Models\\Item',
            'tags' => [
                1,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 38,
        "tags": [
            {
                "id": 3,
                "name": "For Sale",
                "color": "#c70000",
                "type": "App\\Models\\Device"
            }
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found."
}

Request   

POST api/v3/admin/tags/unassign

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

entity_id   integer     

The id of the entity. Example: 1

entity_type   string     

The type of the tag. Example: App\Models\Item

Must be one of:
  • App\Models\Colocation
  • App\Models\Device
  • App\Models\Item
  • App\Models\ItemPort
  • App\Models\ItemSensor
  • App\Models\ItemVlan
  • App\Models\Order
  • App\Models\User
  • Modules\Addons\IPManager\Model\IpamSubnet
tags   integer[]  optional    

Array of tags ids. The id of an existing record in the tags table.

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."
        ]
    }
}

Request   

POST api/v3/login

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

The user's email address. Must be a valid email address. Example: [email protected]

password   string     

The user's password. Example: secret123

device_name   string     

A name for the device making the request. Example: iPhone 13

token_ttl   integer  optional    

Optional custom token lifetime in minutes. Use 0 for non-expiring token. Defaults to 1440 (1 day). Must be at least 0. Example: 0

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."
}

Request   

POST api/v3/password/remind

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

The email address associated with the user's account. Must be a valid email address. Must not be greater than 255 characters. Example: [email protected]

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."
}

Request   

POST api/v3/password/restore

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

token   string     

The password reset token received by email. Example: 123456abcdef

password   string     

The new password (must be confirmed). Must be at least 5 characters. Example: NewSecureP@ss123

password_confirmation   string     

Must match the password field. Must be at least 5 characters. Example: NewSecureP@ss123

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."
}

Request   

GET api/v3/activate/{token}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

token   string     

The unique activation token sent by email. Example: 9bdf52c2-2e13-4f9c-a53d-2b3f45ea9c20

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"
        }
    ]
}

Request   

GET api/v3/oauth/providers

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

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."
}

Request   

POST api/v3/oauth/redirect

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

provider   string     

Provider slug (e.g. "Google", "Github", "CustomClientArea"). Must not be greater than 64 characters. Example: Google

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"
}

Request   

POST api/v3/oauth/callback

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

provider   string     

The OAuth provider slug (e.g. "Google", "Github", "CustomClientArea"). Must not be greater than 64 characters. Example: Google

code   string     

Authorization code received from the provider. Example: 4/0AfJohXKXYZ...

state   string     

State parameter for CSRF protection, must match the one stored in session. Example: abc123xyz

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
}

Request   

POST api/v3/logout

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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"
        }
    }
}

Request   

GET api/v3/client/system/translations/{locale}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

locale   string     

The language code (e.g. "en", "pl"). Example: en

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."
}

Request   

GET api/v3/client/system-settings

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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));

Request   

POST api/v3/client/user/autologin

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

token   string     

One-time autologin token generated for impersonation or quick login. Example: e32cc8f1004a581583b2702c1fbf8354

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": 9470,
        "username": "kpagac",
        "firstname": "Holly",
        "lastname": "Ernser",
        "name": "Holly Ernser",
        "email": "[email protected]",
        "company": null,
        "avatar": "//www.gravatar.com/avatar/f63f666f95c893327c57a7f60f45116f?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/f63f666f95c893327c57a7f60f45116f?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."
}

Request   

GET api/v3/client/user

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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": 9471,
        "username": "lucas.kshlerin",
        "firstname": "Sierra",
        "lastname": "Mayert",
        "name": "Sierra Mayert",
        "email": "[email protected]",
        "company": null,
        "avatar": "//www.gravatar.com/avatar/7d60223b6a940b3d81cb6a78b5cf5837?s=30&d=mm&r=g",
        "large_avatar": "//www.gravatar.com/avatar/7d60223b6a940b3d81cb6a78b5cf5837?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."
}

Request   

PUT api/v3/client/user/edit

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

The user's email address. Must be unique. Must be a valid email address. Must not be greater than 255 characters. Example: [email protected]

firstname   string  optional    

The user's first name. Max 255 characters. Must not be greater than 255 characters. Example: John

lastname   string  optional    

The user's last name. Max 255 characters. Must not be greater than 255 characters. Example: Doe

company   string  optional    

The user's company name. Optional. Max 255 characters. Must not be greater than 255 characters. Example: Acme Inc.

locale   string  optional    

The language preference (e.g., ISO code). Example: en

timezone   integer  optional    

The ID of the selected timezone. See the Show System Configuration endpoint for valid values. Example: 133

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."
}

Request   

PUT api/v3/client/user/edit-password

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

current_password   string     

The user's current password. Example: OldP@ssword123

password   string     

The new password (must be confirmed). Must be at least 5 characters. Example: NewSecureP@ss123

password_confirmation   string     

Must match the password field. Must be at least 5 characters. Example: NewSecureP@ss123

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."
}

Request   

GET api/v3/client/user/autologin

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

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": 85,
            "name": "aut nam",
            "ssh_key": "ssh-rsa YWI4YmM3Y2FlYzc3NTEyZTNmZTkxZjJlYTFlOTA3MzUwNGRhNDAwMTU1ODM1OWI3Y2NjYTIzYzhlODljZGFkYg== user@host",
            "default": false,
            "fingerprint": "61:cf:91:77:24:36:1c:18:92:28:31:7f:05:ab:14:36",
            "created_at": "2025-11-12 09:09:09"
        },
        {
            "id": 86,
            "name": "quisquam corporis",
            "ssh_key": "ssh-rsa YjdjNzcyZDhhODc2YTgzYjUzOThlNDBkNTU1Njk5OGM4MDFmNGMxN2MzOWUzZDZjYTFjMDc1ZmU4MmZkYzVkZQ== user@host",
            "default": false,
            "fingerprint": "47:d3:34:06:0b:ba:c6:77:f8:b8:d6:b7:cb:fd:1e:37",
            "created_at": "2025-11-12 09:09:09"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/user/ssh-keys

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, fingerprint, default, user_id, created_at. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, user_id. Example: id

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\": false
}"

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": 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/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' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 87,
        "name": "aut et",
        "ssh_key": "ssh-rsa MmQxNmNhMWI1MTYyYTc1OGRhNDk1M2U5MzA0OTM1ZmRjNWM5NTViOTAzNmEzZWQ0YjZiZWU1YzJkMTc3YThlMQ== user@host",
        "default": false,
        "fingerprint": "9c:6a:b4:c9:2c:db:d9:0c:11:98:09:98:9f:eb:4e:83",
        "created_at": "2025-11-12 09:09:09"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you."
}

Request   

POST api/v3/client/user/ssh-keys

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The name of the SSH key. Example: Public Key

ssh_key   string     

The public SSH key content. Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...

default   boolean  optional    

Whether the key should be set as default. Example: false

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\": false
}"

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": 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/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' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 88,
        "name": "fugit molestiae",
        "ssh_key": "ssh-rsa MGNmMzJmZjg0N2E1OTgzM2U1YzViNzY3ZTI2ZTk5Y2UzNDM3M2IxZDcwMmQ1ZGNjN2VhZjc4YmQyY2Q4NGQzOQ== user@host",
        "default": false,
        "fingerprint": "14:fc:78:fe:31:43:65:8f:2b:16:8c:3a:0c:6e:93:2e",
        "created_at": "2025-11-12 09:09: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.|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."
}

Request   

PUT api/v3/client/user/ssh-keys/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the SSH key to update. Example: 3

Body Parameters

name   string     

The name of the SSH key. Example: Public Key

ssh_key   string     

The public SSH key content. Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...

default   boolean  optional    

Whether the key should be set as default. Example: false

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": 89,
        "name": "sequi et",
        "ssh_key": "ssh-rsa ZTg2Nzc2ZTEzMzU1ZGY5MDMxYWE4YThhMmYyMDQ4YzI3YzY1MmE0Y2FhNjJkNTBhMDg0M2NjYTBlOTE2NjhmZA== user@host",
        "default": false,
        "fingerprint": "cd:a3:4e:33:8d:f9:96:ca:bc:a6:f4:65:27:19:d0:e0",
        "created_at": "2025-11-12 09:09: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.|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."
}

Request   

POST api/v3/client/user/ssh-keys/{id}/set-as-default

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the SSH key to mark as default. Example: 7

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/4" \
    --header "Authorization: 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/4'
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/4';
$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."
}

Request   

DELETE api/v3/client/user/ssh-keys/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ssh key. Example: 4

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": 86,
            "related_id": 1661,
            "related": {
                "label": "consequatur",
                "model": "dolor",
                "location": "Morissette and Sons",
                "location_flag": "Germany.png",
                "metadata": []
            },
            "type": "Colocation",
            "status": "",
            "created_at": "2025-11-12 09:09:11"
        },
        {
            "id": 87,
            "related_id": 1662,
            "related": {
                "label": "iure",
                "model": "quae",
                "location": "Collier LLC",
                "location_flag": "UK.png",
                "metadata": []
            },
            "type": "Colocation",
            "status": "terminated",
            "created_at": "2025-11-12 09:09:13"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

filter   string  optional    

optional Filter services by status group. Allowed values: all, active, inactive. Default: all. Example: active

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, type, status, related.label, related.model, related.location, related.ip. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, type, status, related.label, related.model, related.location, related.ip. Example: id

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": 88,
        "related_id": 1663,
        "type": "Server",
        "status": "activated",
        "created_at": "2025-11-12 09:09:14",
        "related": {
            "label": "exercitationem",
            "model": "incidunt",
            "location": "Christiansen Inc",
            "location_flag": "UK.png",
            "rack": "Unknown",
            "device_status": "running",
            "os_installation": 0,
            "uptime": {
                "is_down": false,
                "value": "Unknown"
            },
            "ip_addresses": [],
            "metadata": [],
            "metadataGroups": []
        },
        "access_level": {
            "id": 81,
            "name": "cupiditate",
            "type": "Server",
            "default": false,
            "value": "a:5:{s:13:\"base_features\";a:5:{i:0;s:8:\"location\";i:1;s:8:\"position\";i:2;s:11:\"description\";i:3;s:5:\"model\";i:4;s:5:\"label\";}s:18:\"traffic_statistics\";a:5:{i:0;s:9:\"filtering\";i:1;s:17:\"widget_last_month\";i:2;s:23:\"widget_last_month_graph\";i:3;s:20:\"widget_network_ports\";i:4;s:17:\"left_sidebar_link\";}s:5:\"power\";a:6:{i:0;s:17:\"widget_last_month\";i:1;s:20:\"widget_average_usage\";i:2;s:7:\"outlets\";i:3;s:9:\"filtering\";i:4;s:17:\"left_sidebar_link\";i:5;s:23:\"widget_last_month_graph\";}s:4:\"ipam\";a:1:{i:0;s:30:\"ipam_widget_in_service_summary\";}s:11:\"dns-manager\";a:4:{i:0;s:11:\"update_rdns\";i:1;s:11:\"delete_rdns\";i:2;s:22:\"rdns_left_sidebar_link\";i:3;s:11:\"create_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."
}

Request   

GET api/v3/client/services/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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."
}

Request   

POST api/v3/client/services/{id}/bandwidth

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 101

Body Parameters

startDate   string  optional    

The start date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-01 00:00:00

endDate   string  optional    

The end date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-31 23:59:59

units   string  optional    

The unit of bandwidth. Must be one of: MB, GB, TB. Example: GB

Must be one of:
  • MB
  • GB
  • TB
ports   object  optional    

An array of device port names to include in the traffic query.

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."
}

Request   

POST api/v3/client/services/{id}/powerusage

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 101

Body Parameters

startDate   string  optional    

The start date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-01 00:00:00

endDate   string  optional    

The end date for the traffic range. Must be a valid date. Must be a valid date. Example: 2024-01-31 23:59:59

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."
}

Request   

POST api/v3/client/services/{id}/assign-metadata

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 1

Body Parameters

slug   string     

The slug of the item metadata field. The slug of an existing record in the types_fields table. Example: ipmi.ip

value   string     

The value for the item metadata field. Example: 192.168.56.180

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."
}

Request   

POST api/v3/client/services/{id}/power/action

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Body Parameters

action   string     

The power action to perform. One of: boot, reboot, shutdown. Example: boot

Must be one of:
  • boot
  • reboot
  • shutdown
device_id   integer  optional    

The ID of the device assigned to the colocation linked with the given service. Required only for colocation-type services when performing a power action on a specific device. Must reference a valid device associated with the colocation belonging to the service. The id of an existing record in the items table. Example: 1

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": 1664,
            "label": "fuga",
            "type": "doloribus"
        },
        {
            "id": 1665,
            "label": "nihil",
            "type": "debitis"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/parts

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, label, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, label, type. Example: id

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": 539,
            "port_number": 34,
            "port_label": "ut",
            "user_label": "minus",
            "outlet_state": "Outlet On",
            "connected_item": null,
            "connected_port": null,
            "power_usage": 57,
            "power_usage_units": "Amps"
        },
        {
            "id": 540,
            "port_number": 14,
            "port_label": "quasi",
            "user_label": "aut",
            "outlet_state": "Outlet Off",
            "connected_item": null,
            "connected_port": null,
            "power_usage": 82,
            "power_usage_units": "Amps"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/power-ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, port_number, port_label, user_label, power_usage. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, port_number, port_label, user_label, power_usage. Example: id

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": 541,
        "port_number": 37,
        "port_label": "labore",
        "user_label": "et",
        "outlet_state": "Outlet On",
        "connected_item": null,
        "connected_port": null,
        "power_usage": 2,
        "power_usage_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."
}

Request   

POST api/v3/client/services/{id}/power-ports/action

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Body Parameters

port_id   integer     

The ID of the power port on which to perform the action. Example: 45

action   string     

The outlet action to perform. Must be one of: outletOn, outletOff, outletReboot. Example: outletOff

Must be one of:
  • outletOn
  • outletOff
  • outletReboot

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": 46405,
            "name": null,
            "port_number": 31,
            "port_label": "ipsa",
            "user_label": "cupiditate",
            "description": "Est rerum laboriosam mollitia tempora.",
            "if_type": "hssi",
            "adminstate": "up",
            "opstate": "down",
            "connected_item": null,
            "connected_port": null,
            "connection": "Unknown",
            "speed": "100 bps"
        },
        {
            "id": 46406,
            "name": null,
            "port_number": 21,
            "port_label": "eos",
            "user_label": "adipisci",
            "description": "Enim atque qui optio aut laboriosam facere est.",
            "if_type": "macSecControlledIF",
            "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": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/ports

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

with_traffic   boolean  optional    

Include traffic statistics (last 1 hour, last 1 day, last 1 month) for each port. Default: false. Example: true

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, port_number, port_label, user_label, description, if_type, adminstate, opstate, speed. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, port_number, port_label, user_label, description, if_type, adminstate, opstate. Example: id

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": 367,
            "item_id": 1671,
            "name": "facere",
            "class": "Fans",
            "type": "Power",
            "unit": "Amps",
            "index": "Power",
            "reading": 687,
            "last_polled": "0000-00-00 00:00:00",
            "configuration": [],
            "created_at": "2025-11-12 09:09:22",
            "updated_at": "2025-11-12 09:09:22"
        },
        {
            "id": 368,
            "item_id": 1672,
            "name": "laborum",
            "class": "Power Supply",
            "type": "Thermal",
            "unit": "Celsius",
            "index": "Thermal",
            "reading": 93,
            "last_polled": "0000-00-00 00:00:00",
            "configuration": [],
            "created_at": "2025-11-12 09:09:23",
            "updated_at": "2025-11-12 09:09:23"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/sensors

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 1

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, name, class, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, item_id, name, class, type. Example: id

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": 369,
        "item_id": 1673,
        "name": "nihil",
        "class": "Power Supply",
        "type": "Thermal",
        "unit": "Percent",
        "index": "Thermal",
        "reading": 811,
        "last_polled": "0000-00-00 00:00:00",
        "configuration": [],
        "created_at": "2025-11-12 09:09:24",
        "updated_at": "2025-11-12 09:09:24"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

GET api/v3/client/services/{id}/sensors/{sensorId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 1

sensorId   integer     

The ID of the sensor. Example: 11

Graphs

Export Graph

requires authentication

Exports a graph data for a given target

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/client/graphs/42/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"AggregateTraffic\",
    \"target\": \"service\",
    \"start\": \"2025-04-01 00:00:00\",
    \"end\": \"2025-04-30 23:59:59\",
    \"raw\": false
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/client/graphs/42/export'
payload = {
    "type": "AggregateTraffic",
    "target": "service",
    "start": "2025-04-01 00:00:00",
    "end": "2025-04-30 23:59:59",
    "raw": false
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/graphs/42/export';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'AggregateTraffic',
            'target' => 'service',
            'start' => '2025-04-01 00:00:00',
            'end' => '2025-04-30 23:59:59',
            'raw' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "datasets": [
            {
                "data": [
                    "0.00186",
                    "0.00000",
                    "0.00231",
                    "0.00231",
                    "0.00228",
                    "0.00229",
                    "0.00006",
                    "0.00219",
                    "0.00245",
                    "0.00336",
                    "0.00337",
                    "0.00191",
                    "0.00000"
                ],
                "dataset_name": "inboundtotal"
            },
            {
                "data": [
                    "0.00045",
                    "0.00046",
                    "0.00321",
                    "0.00321",
                    "0.00000",
                    "0.00232",
                    "0.00198",
                    "0.00193",
                    "0.00036",
                    "0.00036",
                    "0.00145",
                    "0.00286",
                    "0.00000"
                ],
                "dataset_name": "outboundtotal"
            },
            {
                "data": [
                    "0.00232",
                    "0.00046",
                    "0.00552",
                    "0.00552",
                    "0.00228",
                    "0.00461",
                    "0.00204",
                    "0.00412",
                    "0.00281",
                    "0.00372",
                    "0.00482",
                    "0.00478",
                    "0.00000"
                ],
                "dataset_name": "totalboundbits"
            },
            {
                "data": [
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336",
                    "0.00336"
                ],
                "dataset_name": "95_percentile"
            }
        ],
        "labels": [
            "2025-10-21 13:35:00",
            "2025-10-21 13:40:00",
            "2025-10-21 13:45:00",
            "2025-10-21 13:50:00",
            "2025-10-21 13:55:00",
            "2025-10-21 14:00:00",
            "2025-10-21 14:05:00",
            "2025-10-21 14:10:00",
            "2025-10-21 14:15:00",
            "2025-10-21 14:20:00",
            "2025-10-21 14:25:00",
            "2025-10-21 14:30:00",
            "2025-10-21 14:35:00"
        ]
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users."
}

Example response (404, Not Found):


{
    "success": false,
    "status": "error",
    "message": "Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you."
}

Request   

POST api/v3/client/graphs/{id}/export

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the target. Example: 42

Body Parameters

type   string     

The type of graph to export, depending on the target. Example: AggregateTraffic

Must be one of:
  • AggregateTraffic
  • Load
  • OutletPowerUsage
  • Ping
  • PowerUsage
  • Sensor
  • ServerPowerUsage
  • Status
target   string     

The type of target to graph (e.g., service, itempowerport, itemsensor). Example: service

Must be one of:
  • service
  • itempowerport
  • itemsensor
start   string  optional    

Start datetime for the graph range in format Y-m-d H:i:s. Must be a valid date in the format Y-m-d H:i:s. Example: 2025-04-01 00:00:00

end   string  optional    

End datetime for the graph range in format Y-m-d H:i:s. Must be after or equal to start. Must be a valid date in the format Y-m-d H:i:s. Must be a date after or equal to start. Example: 2025-04-30 23:59:59

raw   boolean  optional    

Whether to return raw graph data. Example: false

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": 226,
            "name": "illum-iso",
            "iso_url": "http://erdman.com/facilis-delectus-et-est.html",
            "status": 4,
            "download": {
                "status": "error",
                "message": "Download error: Unknown error occurred."
            },
            "created_at": "2025-11-12 09:10:14",
            "updated_at": "2025-11-12 09:10:14"
        },
        {
            "id": 227,
            "name": "qui-iso",
            "iso_url": "http://herman.com/earum-dolorum-iure-voluptatibus-sed-modi-et-deleniti-facere",
            "status": 3,
            "download": {
                "status": "finished",
                "message": "The ISO image download has completed successfully."
            },
            "created_at": "2025-11-12 09:10:14",
            "updated_at": "2025-11-12 09:10:14"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/os/isoimages

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, iso_url, status. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, iso_url, status. Example: id

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": 228,
        "name": "fugit-iso",
        "iso_url": "http://emard.net/repellendus-fugit-dolores-sit",
        "status": 1,
        "download": {
            "status": "waiting",
            "message": "Waiting for ISO image download to start..."
        },
        "created_at": "2025-11-12 09:10:14",
        "updated_at": "2025-11-12 09:10:14"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

POST api/v3/client/os/isoimages

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The display name for the ISO image. Must not be greater than 255 characters. Example: Ubuntu Server ISO

iso_url   string     

Direct URL to the ISO file. Must be publicly accessible and point to a valid .iso resource. Must be a valid URL. Example: https://example.com/images/ubuntu.iso

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": 229,
        "name": "itaque-iso",
        "iso_url": "http://www.mcglynn.com/ut-perferendis-corrupti-reprehenderit-quam-ipsa-fugiat.html",
        "status": 3,
        "download": {
            "status": "finished",
            "message": "The ISO image download has completed successfully."
        },
        "created_at": "2025-11-12 09:10:14",
        "updated_at": "2025-11-12 09:10:14"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

PUT api/v3/client/os/isoimages/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ISO image to update. Example: 3

Body Parameters

name   string     

The new name for the ISO image. Must not be greater than 255 characters. Example: Updated ISO Name

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."
}

Request   

DELETE api/v3/client/os/isoimages/{id}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the ISO image to delete. Example: 3

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": 298,
            "template_id": 298,
            "name": "iusto",
            "tags": [
                "est",
                "porro",
                "ex",
                "nihil"
            ],
            "architecture": "x86",
            "cache_folder": "rerum",
            "mirror": "http://www.kunze.com/velit-facere-velit-exercitationem-voluptas",
            "edition": "laborum",
            "iso_url": "http://dickinson.biz/quam-molestiae-vel-qui-voluptatem-quia",
            "tftp_url": "http://www.brakus.com/et-ut-maxime-quis-molestiae-voluptas-facilis-illum",
            "license": "omnis",
            "gpxe": "Quaerat omnis labore quod est deleniti.",
            "disk_layout": "Dolorem qui ratione atque sed temporibus.",
            "packages": "Provident necessitatibus necessitatibus voluptatem iusto.",
            "pre_installation": "Eum qui repellat voluptatem sunt.",
            "post_installation": "Eum aut praesentium et quia est quis voluptas.",
            "first_boot": "Sint quae explicabo necessitatibus voluptatibus dolores.",
            "extras": "Et recusandae sit sequi sequi sapiente repellat quia.",
            "timezone": "America/Guatemala",
            "language": "kn",
            "family": "",
            "is_windows": false,
            "is_rescue": false
        },
        {
            "id": 299,
            "template_id": 299,
            "name": "minima",
            "tags": [
                "officiis",
                "laborum",
                "quo"
            ],
            "architecture": "arm",
            "cache_folder": "quo",
            "mirror": "https://www.harber.net/cupiditate-velit-consectetur-libero-ipsam",
            "edition": "ut",
            "iso_url": "http://rempel.biz/labore-ab-est-laboriosam-qui.html",
            "tftp_url": "http://www.mann.com/",
            "license": "sequi",
            "gpxe": "Adipisci eum nemo blanditiis sequi incidunt.",
            "disk_layout": "Sit dolores cumque asperiores aut dolorum perspiciatis.",
            "packages": "Labore est quibusdam enim facilis.",
            "pre_installation": "Aspernatur occaecati omnis optio.",
            "post_installation": "Nemo pariatur voluptatibus ipsa totam animi.",
            "first_boot": "Quisquam aut voluptates consequuntur vel.",
            "extras": "Aliquid eos aspernatur enim.",
            "timezone": "Europe/Madrid",
            "language": "nb",
            "family": "",
            "is_windows": false,
            "is_rescue": false
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/os/templates

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

with_addons   boolean  optional    

Optional. If set to true, includes a list of addons for each template. Example: true

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, edition, architecture, family. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, edition, architecture, tags, family. Example: id

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": 124,
            "name": "Arno Carroll",
            "description": "Qui delectus ea sed architecto non.",
            "type": "disklayout",
            "tag": "quis rerum",
            "tags": [
                "quis",
                "rerum"
            ],
            "data": "Sit repudiandae voluptatem maiores totam eligendi libero eligendi."
        },
        {
            "id": 125,
            "name": "Mrs. Rachel Purdy Jr.",
            "description": "Eum sunt enim aut corporis.",
            "type": "firstboot",
            "tag": "numquam exercitationem",
            "tags": [
                "numquam",
                "exercitationem"
            ],
            "data": "Adipisci eos aut id illo sed omnis."
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/os/addons

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, name, type, tag. Example: id

Install OS on Device

requires authentication

Initiates OS installation on a device assigned to the given service

Example request:
curl --request POST \
    "https://your-easydcim.com/api/v3/client/services/123/os/install" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"template\": 12,
    \"hostname\": \"server01.example.com\",
    \"username\": \"admin\",
    \"password\": \"secret123\",
    \"root_password\": \"rootsecret\",
    \"disk_addon\": 1,
    \"extras\": [
        1
    ],
    \"ssh_keys\": [
        14
    ]
}"

import requests
import json

url = 'https://your-easydcim.com/api/v3/client/services/123/os/install'
payload = {
    "template": 12,
    "hostname": "server01.example.com",
    "username": "admin",
    "password": "secret123",
    "root_password": "rootsecret",
    "disk_addon": 1,
    "extras": [
        1
    ],
    "ssh_keys": [
        14
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/os/install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'template' => 12,
            'hostname' => 'server01.example.com',
            'username' => 'admin',
            'password' => 'secret123',
            'root_password' => 'rootsecret',
            'disk_addon' => 1,
            'extras' => [
                1,
            ],
            'ssh_keys' => [
                14,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": {
        "id": 247,
        "device_id": 1713,
        "template_id": 300,
        "message": "Delectus odio qui magnam et ipsum nostrum.",
        "log": "",
        "created_at": "2025-11-12 09:10:14",
        "updated_at": "2025-11-12 09:10:14"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

POST api/v3/client/services/{id}/os/install

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Body Parameters

template   integer     

ID or identifier of the OS template to install. Example: 12

hostname   string  optional    

Optional hostname for the new system. Example: server01.example.com

username   string     

Username for the new system. Example: admin

password   string     

Password for the user account. Example: secret123

root_password   string  optional    

Root password for the system (optional). Example: rootsecret

disk_addon   integer  optional    

Optional ID of an additional disk to use during installation. Example: 1

extras   integer[]  optional    
ssh_keys   integer[]  optional    

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."
}

Request   

POST api/v3/client/services/{id}/os/cancel

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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": 248,
        "device_id": 1714,
        "template_id": 301,
        "message": "Commodi error soluta rerum est et ab in.",
        "log": "",
        "created_at": "2025-11-12 09:10:15",
        "updated_at": "2025-11-12 09:10:15"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

GET api/v3/client/services/{id}/os/install/information

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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": 249,
        "device_id": 1715,
        "template_id": 302,
        "message": "Aut fuga officiis consequatur velit.",
        "log": "",
        "created_at": "2025-11-12 09:10:15",
        "updated_at": "2025-11-12 09:10:15"
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "Missing bearer token.|Invalid bearer token|Token not provided."
}

Example response (403, Forbidden):


{
    "success": false,
    "status": "error",
    "message": "Your account is inactive or banned.|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."
}

Request   

POST api/v3/client/services/{id}/os/rescue/enable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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."
}

Request   

GET api/v3/client/services/{id}/os/rescue/status

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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."
}

Request   

POST api/v3/client/services/{id}/ipmi/bmc-reset-cold

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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": 195,
        "device_id": 1723,
        "url": "https://easydcim-shift.local/client/console/44054/qiS8zoBq/6269012fad56b70205ae90c0362ab7081513f243",
        "status": 1,
        "message": "Aut quia quis velit architecto molestiae."
    }
}

Example response (401, Unauthorized):


{
    "success": false,
    "status": "error",
    "message": "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."
}

Request   

POST api/v3/client/services/{id}/ipmi/novnc-connect

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

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"
    }
}

Request   

POST api/v3/client/ipmi/console/information

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

The unique session password used to identify the IPMI proxy session. Example: 3bf5By

port   integer     

The port used for the proxy session. Example: 5901

token   string     

The unique session token used to identify the IPMI proxy session. Example: 1784360e52abb6d874b92747ea9df6fabde33a20

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
}

Request   

POST api/v3/client/ipmi/console/activity

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

The unique session password used to identify the IPMI proxy session. Example: 3bf5By

port   integer     

The port used for the proxy session. Example: 5901

token   string     

The unique session token used to identify the IPMI proxy session. Example: 1784360e52abb6d874b92747ea9df6fabde33a20

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
}

Request   

POST api/v3/client/ipmi/console/close

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

The unique session password used to identify the IPMI proxy session. Example: 3bf5By

port   integer     

The port used for the proxy session. Example: 5901

token   string     

The unique session token used to identify the IPMI proxy session. Example: 1784360e52abb6d874b92747ea9df6fabde33a20

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": 103,
            "device_id": 1728,
            "user_id": 9911,
            "server_id": 151,
            "ip": "52.188.39.92",
            "from": "gorczany.org",
            "name": "brown.com",
            "ttl": "3600",
            "created_at": "2025-11-12 09:10:22",
            "updated_at": "2025-11-12 09:10:22"
        },
        {
            "id": 104,
            "device_id": 1729,
            "user_id": 9919,
            "server_id": 152,
            "ip": "118.244.12.15",
            "from": "hickle.org",
            "name": "walter.com",
            "ttl": "3600",
            "created_at": "2025-11-12 09:10:22",
            "updated_at": "2025-11-12 09:10:22"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/rdns

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, device_id, user_id, server_id, ip, from, name, ttl, created_at. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: id, device_id, user_id, server_id, ip, from, name, created_at. Example: id

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."
}

Request   

POST api/v3/client/services/{id}/rdns

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Body Parameters

ip   string     

The IP address to associate with the reverse DNS record. Must be a valid IP address. Example: 192.168.1.1

rdata   string     

The domain name (PTR) that should resolve for the IP. Example: example.mydomain.com

ttl   integer  optional    

Optional TTL (Time To Live) value for the record in seconds. Must be at least 60. Example: 3600

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."
}

Request   

POST api/v3/client/services/{id}/rdns/{recordId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

recordId   integer     

The ID of the rDNS record. Example: 456

Body Parameters

rdata   string     

The domain name (PTR) to update for this record. Example: updated.example.net

ttl   integer  optional    

Optional TTL (Time To Live) value in seconds. Must be at least 60. Example: 3600

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."
}

Request   

DELETE api/v3/client/services/{id}/rdns/{recordId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

recordId   integer     

The ID of the rDNS record. Example: 456

Password Manager

List access details

requires authentication

This endpoint returns a paginated collection of access details

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/client/pm/access?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=name" \
    --header "Authorization: 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/pm/access'
params = {
  'per_page': '10',
  'page': '1',
  'sort_by': 'id',
  'sort_dir': 'asc',
  'search_term': 'active,pending',
  'search_op': 'like',
  'search_fields': 'name',
}
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/pm/access';
$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' => 'name',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 116,
            "name": "quo numquam repellendus",
            "owner_id": 10013,
            "device_id": 1742,
            "username": "wolf.shanon",
            "password": "secret123",
            "website": "casper.com",
            "login_url": "https://mcclure.com/explicabo-fuga-animi-deserunt-earum-ut-dolorem.html",
            "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQfbeb48c98a619b4868ff5da666eb6e2489534f26",
            "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\nd72cae7952a78c3d6455457a4d7610656d58c3819557ec944a8f2076ebcd84ae\n-----END PRIVATE KEY-----",
            "notes": "Consequatur quis maxime aliquam labore iusto nemo.",
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        },
        {
            "id": 117,
            "name": "veritatis adipisci aut",
            "owner_id": 10021,
            "device_id": 1743,
            "username": "ceasar.hoeger",
            "password": "secret123",
            "website": "vandervort.biz",
            "login_url": "http://goyette.com/reiciendis-unde-omnis-laudantium-aut-quaerat-et-delectus-tempora",
            "public_ssh_keys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ82a50eb7041879f5813db21609d1ce411cc6c2c0",
            "private_ssh_keys": "-----BEGIN PRIVATE KEY-----\nf83ceafdea58b1948514bd9d4c41ce001f9040684ef6cea34d5a218a0bc678a6\n-----END PRIVATE KEY-----",
            "notes": "Inventore tenetur vitae totam et veritatis esse aut qui.",
            "created_at": "2025-11-12 09:10:28",
            "updated_at": "2025-11-12 09:10:28"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://your-easydcim.com/api/v3/client/pm/access?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://your-easydcim.com/api/v3/client/pm/access",
        "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."
}

Request   

GET api/v3/client/pm/access

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, name, device_id, username, password, website, login_url. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: name, device_id, username, password, website, login_url. Example: name

IP Address Management

List of IP addresses

requires authentication

This endpoint returns a paginated collection of IP addresses associated with the specified service.

Example request:
curl --request GET \
    --get "https://your-easydcim.com/api/v3/client/services/123/ipaddresses?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=value" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
import requests
import json

url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses'
params = {
  'per_page': '10',
  'page': '1',
  'sort_by': 'id',
  'sort_dir': 'asc',
  'search_term': 'active,pending',
  'search_op': 'like',
  'search_fields': 'value',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()
$client = new \GuzzleHttp\Client();
$url = 'https://your-easydcim.com/api/v3/client/services/123/ipaddresses';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '10',
            'page' => '1',
            'sort_by' => 'id',
            'sort_dir' => 'asc',
            'search_term' => 'active,pending',
            'search_op' => 'like',
            'search_fields' => 'value',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "success": true,
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 265,
            "item_id": 38,
            "value": "200.94.209.231",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 307,
            "item_id": 44,
            "value": "146.224.170.224",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 314,
            "item_id": 45,
            "value": "139.235.236.138",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 328,
            "item_id": 47,
            "value": "207.243.68.21",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 335,
            "item_id": 48,
            "value": "46.236.68.242",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 342,
            "item_id": 49,
            "value": "166.73.24.58",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 356,
            "item_id": 51,
            "value": "160.24.83.37",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 363,
            "item_id": 52,
            "value": "80.24.122.22",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 370,
            "item_id": 53,
            "value": "174.251.45.79",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        },
        {
            "id": 377,
            "item_id": 54,
            "value": "155.150.252.1",
            "description": "",
            "type": "primary",
            "ip_type": "ipv4"
        }
    ],
    "links": {
        "first": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=1",
        "last": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=16",
        "prev": null,
        "next": "https://your-easydcim.com/api/v3/admin/ipam/ips?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 16,
        "links": [
            {
                "url": null,
                "label": "&laquo; 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 &raquo;",
                "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."
}

Request   

GET api/v3/client/services/{id}/ipaddresses

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

Query Parameters

per_page   integer  optional    

The number of items per page (min:1, max:100). Example: 10

page   integer  optional    

The page number of results to return. Example: 1

sort_by   string  optional    

The field to sort by. Allowed: id, item_id, value, description, type, ip_type. Example: id

sort_dir   string  optional    

The direction of sorting. Allowed values: asc, desc. Example: asc

search_term   string  optional    

Search value. For in/not_in provide comma-separated. For between provide two values comma-separated (from,to). Example: active,pending

search_op   string  optional    

How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between. Example: like

search_fields   array|string  optional    

Optional. Restrict search to specific fields. Allowed: value, description, type, ip_type. Example: value

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."
}

Request   

POST api/v3/client/services/{id}/ipaddresses/{entityId}

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the service. Example: 123

entityId   integer     

The ID of the IP address entity. Example: 456

Body Parameters

description   string  optional    

Description or label for the IP address. Example: Primary IP for web server

ip_address   string     

IP Address for which description will be updated. Example: 192.168.56.1

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."
}

Request   

POST api/v3/client/two-factor/enable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

module_name   string     

The identifier of the 2FA module to enable. Currently supported: "Totp". Example: Totp

Must be one of:
  • Totp

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."
}

Request   

POST api/v3/client/two-factor/disable

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

The current password of the user, required to disable two-factor authentication. Example: user_current_password

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."
}

Request   

POST api/v3/client/two-factor/store

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

module_name   string     

The identifier of the 2FA module to configure. Currently supported: "Totp". Example: Totp

Must be one of:
  • Totp
configuration   object     

Key-value configuration specific to the selected 2FA module. For the "Totp" module, the array must contain the fields: "code" (current token) and "secret_word" (shared secret).

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."
}

Request   

POST api/v3/client/two-factor/validate

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

configuration   object     

Container for second-factor verification data.
code   string     

The 2FA code generated by the authenticator app. Must be at least 4 characters. Must not be greater than 10 characters. Example: 123456

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."
}

Request   

POST api/v3/client/two-factor/backup-code

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

code   string     

The backup code defined during 2FA setup. Must be at least 6 characters. Must not be greater than 255 characters. Example: MY-BACKUP-CODE-123