For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • NVIDIA Switch Infrastructure
    • I want to...
  • Quick Start
    • Start Here
    • Getting Started with Config Manager
    • TUI Wizard Reference
    • Configuration Samples
    • Interfaces
    • Local Development Quick Start
    • First Run Tour
  • Config Manager Overview
    • Config Manager Concepts
    • Getting Started with Nautobot
  • User Guides
    • New Site Bringup
    • Workflow Lifecycle
  • Deployment
    • Hosting Options
    • Network Topology Requirements
    • Firewall Ports
    • Airgapped Deployment
    • Troubleshooting
  • Services
      • Network Infrastructure Automation with Temporal
      • Temporal Deployment Process
      • Temporal CLI
      • Workflows for Day 2 Operations
      • Temporal API
        • GETHealthcheck
        • GETRBAC Config Status
        • GETCurrent User Info
          • GETGet Devices
          • GETGet Device ID by Name
          • GETGet Device Password Users
          • GETGet Secret Types for Device
          • GETGet Device Secrets
          • GETGet Diagnostics Commands
          • GETGet Locations
          • GETGet Roles
          • GETGet AIR Simulations
          • GETGet Sites
          • GETGet Statuses
          • GETGet Tenants
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
ServicesTemporal ServiceTemporal APIparameters

Get Device ID by Name

||View as Markdown|
GET
https://host.com/v1/parameter/device-id
GET
/v1/parameter/device-id
$curl -G https://host.com/v1/parameter/device-id \
>     -H "Content-Type: application/json" \
>     -d device_name=router-nyc-01
1{
2  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "name": "router-nyc-01",
4  "platform": "Cisco IOS XE"
5}

Convert device hostname to device ID.

Args: device_name: The hostname/name of the device.

Returns: Device object with id and name.

Raises: HTTPException: If device not found or multiple devices match.

Previous

Get Devices

Next

Get Device Password Users

Query parameters

device_namestringRequired

Response

Successful Response
idstring
namestring
platformstring or null

Errors

422
Unprocessable Entity Error