---
title: Get Device By Name
slug: kron-pam-api-collection-3-9-0/get-device-by-name
docTags: 
createdAt: 2026-10-21T06:10:28.166Z
---

{
  "id": "6HBNjm5Z-Ebmbl2hSIoIQ",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "{{url}}/aioc-rest-web/rest/discovery/getDeviceByName/{{deviceName}}",
    "name": "",
    "description": "<h3>Request Overview</h3>\n<p>The <strong>Get Device By Name</strong> method retrieves detailed information about a device based on its name in the KRON PAM system.</p>\n<h4>Usage:</h4>\n<ul>\n<li>Enter the name of the chosen device in the <code>\"DEVICENAME\"</code> field within the request URL.</li>\n</ul>\n<p>This method is used to obtain specific details about the device, such as its ID, management IP, access protocol, and associated device groups.</p>",
    "contentType": "application/json",
    "request": {
      "headerParameters": [
        {
          "name": "Content-Type",
          "description": "",
          "default": "application/json",
          "value": "application/json",
          "type": "string"
        },
        {
          "name": "X-XSRF-TOKEN",
          "description": "",
          "default": "{{csrftoken}}",
          "value": "{{csrftoken}}",
          "type": "string"
        }
      ],
      "queryParameters": [],
      "pathParameters": [
        {
          "name": "url",
          "description": "",
          "default": "url",
          "value": "url",
          "type": "string"
        },
        {
          "name": "deviceName",
          "description": "",
          "default": "deviceName",
          "value": "deviceName",
          "type": "string"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "getDeviceByName",
        "jsonExample": "{\n    \"dbId\": 137963,\n    \"id\": \"55ebb00a-8956-4db1-83f3-512dd5eb5749\",\n    \"name\": \"TestDevice\",\n    \"accessProtocol\": \"SSHv2\",\n    \"managementIp\": \"10.20.40.248\",\n    \"elementType\": {\n        \"dbId\": -1256593,\n        \"elementTypeId\": \"linux\",\n        \"elementTypeName\": \"Linux Server\",\n        \"vendor\": null,\n        \"category\": null,\n        \"elementTypeProperties\": [\n            {\n                \"dbId\": -224107345,\n                \"elementTypePropertyValue\": \"abort\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_c\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328315408,\n                \"elementTypePropertyValue\": \"^Quit.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328317181,\n                \"elementTypePropertyValue\": \"^Are you sure.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328321729,\n                \"elementTypePropertyValue\": \"^Enter the date.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328318769,\n                \"elementTypePropertyValue\": \".*(?i)password[:|&gt].*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -224107346,\n                \"elementTypePropertyValue\": \"do_nothing\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_z\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -355141703,\n                \"elementTypePropertyValue\": \"^Select choice.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -224107347,\n                \"elementTypePropertyValue\": \".*?(&gt|\\\\$|#|%)\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.prompt_pattern\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -316330256,\n                \"elementTypePropertyValue\": \"-1\",\n                \"elementTypePropertyKey\": \"shell.terminal.config.fixed_pty_columns\",\n                \"elementTypePropertyType\": null\n            }\n        ]\n    },\n    \"discoveryTime\": 1549516266097,\n    \"properties\": {\n        \"pseudoDevice\": \"true\"\n    },\n    \"deviceGroups\": [\n        \"8851fead-2b5e-4769-b847-fc8a898999a0\"\n    ],\n    \"availability\": null,\n    \"currentMaintenanceWindow\": null,\n    \"interfaceName\": null,\n    \"nameManagementIp\": \"TestDevice-10.20.40.248\",\n    \"regionName\": null,\n    \"pseudoDevice\": true,\n    \"domainController\": null,\n    \"discoverySource\": null,\n    \"portNum\": null\n}"
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "gWLJVkJ1aXiS6OMSpdp2H",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url {{url}}/aioc-rest-web/rest/discovery/getDeviceByName/{{deviceName}} \\\n     --header 'accept: application/json' \\\n     --header 'x-xsrf-token: {{csrftoken}}'"
        },
        {
          "id": "K8SerbfIU_aX3ddt3bCkI",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-xsrf-token\", \"{{csrftoken}}\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"{{url}}/aioc-rest-web/rest/discovery/getDeviceByName/{{deviceName}}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "ArUh22kzL7nPlLSzU6zoP",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/aioc-rest-web/rest/discovery/getDeviceByName/{{deviceName}}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-xsrf-token\"] = \"{{csrftoken}}\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "aMxtoioJhlyeGw-bklwyy",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"{{url}}/aioc-rest-web/rest/discovery/getDeviceByName/{{deviceName}}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-xsrf-token': '{{csrftoken}}'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "gWLJVkJ1aXiS6OMSpdp2H"
    },
    "results": {
      "languages": [
        {
          "id": "rE-ltfJhqm95ZkmOigRgN",
          "language": "200",
          "code": "{\n    \"dbId\": 137963,\n    \"id\": \"55ebb00a-8956-4db1-83f3-512dd5eb5749\",\n    \"name\": \"TestDevice\",\n    \"accessProtocol\": \"SSHv2\",\n    \"managementIp\": \"10.20.40.248\",\n    \"elementType\": {\n        \"dbId\": -1256593,\n        \"elementTypeId\": \"linux\",\n        \"elementTypeName\": \"Linux Server\",\n        \"vendor\": null,\n        \"category\": null,\n        \"elementTypeProperties\": [\n            {\n                \"dbId\": -224107345,\n                \"elementTypePropertyValue\": \"abort\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_c\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328315408,\n                \"elementTypePropertyValue\": \"^Quit.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328317181,\n                \"elementTypePropertyValue\": \"^Are you sure.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328321729,\n                \"elementTypePropertyValue\": \"^Enter the date.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -328318769,\n                \"elementTypePropertyValue\": \".*(?i)password[:|&gt].*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -224107346,\n                \"elementTypePropertyValue\": \"do_nothing\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_z\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -355141703,\n                \"elementTypePropertyValue\": \"^Select choice.*\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -224107347,\n                \"elementTypePropertyValue\": \".*?(&gt|\\\\$|#|%)\",\n                \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.prompt_pattern\",\n                \"elementTypePropertyType\": null\n            },\n            {\n                \"dbId\": -316330256,\n                \"elementTypePropertyValue\": \"-1\",\n                \"elementTypePropertyKey\": \"shell.terminal.config.fixed_pty_columns\",\n                \"elementTypePropertyType\": null\n            }\n        ]\n    },\n    \"discoveryTime\": 1549516266097,\n    \"properties\": {\n        \"pseudoDevice\": \"true\"\n    },\n    \"deviceGroups\": [\n        \"8851fead-2b5e-4769-b847-fc8a898999a0\"\n    ],\n    \"availability\": null,\n    \"currentMaintenanceWindow\": null,\n    \"interfaceName\": null,\n    \"nameManagementIp\": \"TestDevice-10.20.40.248\",\n    \"regionName\": null,\n    \"pseudoDevice\": true,\n    \"domainController\": null,\n    \"discoverySource\": null,\n    \"portNum\": null\n}"
        }
      ],
      "selectedLanguageId": "rE-ltfJhqm95ZkmOigRgN"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}