For AI agents: a documentation index is available at the root level at /llms.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
Config Manager Overview
- Config Manager Concepts
- Getting Started with Nautobot
Deployment
Services

NVIDIA Switch Infrastructure
I want to...
Start Here
Getting Started with Config Manager
TUI Wizard Reference
Configuration Samples
Interfaces
Local Development Quick Start
DSX Air Simulation
First Run Tour
Config Manager Concepts
System Architecture
Configuration Management
Temporal Workflows
Device Authentication
Observability
Log Message Reference
Remote MCP
API Reference
Getting Started with Nautobot
Nautobot Integration
Nautobot Bootstrap Data
Design Builder Data Loading
Nautobot Bootstrap Data Reference
New Site Bringup
Workflow Lifecycle
Configuration Backup
Configuration Deploy
Multi-Device Deploy
Batch Deploy
Tenant Deploy
Cable Validation
Hardware Validation
Connected Host Metadata
Switch OS Upgrade
NVLink Firmware Upgrade
Reprovision
Device Password Rotation
Site Password Rotation
IB PKey Creation
IB PKey Member Add
IB PKey Member Update
IB PKey Member Delete
IB Port GUID Discovery
SpX Overlay Creation
SpX Overlay Deletion
SpX Overlay Assignment
SpX Overlay Tenant Change
Gateway API and OIDC
Hosting Options
Network Topology Requirements
Firewall Ports
Airgapped Deployment
Troubleshooting
Overview
Architecture
Current User Info
Check cache service status
Test cache lookup for a device
List all devices
Search devices by name with latest config info
Permanently delete all configs for a device
Get database statistics
Get all configs for a device
Batch create/update config files
Get a config file
Create or update a config file
Get diff between two versions
List all versions of a config file
DHCP Service
DHCP Modeling in Nautobot
Flush Cache
Get Config
Healthcheck
Current User Info
Network ZTP
ZTP Architecture
Configuration Guide
Upload Images
ZTP API
Healthcheck
Current User Info
Load Bootscript
Load Configuration
Load Firmware
Load Firmware Checksum
Load Firmware
Mark Provisioned
Validate Serial
List All Files
List Files
Load Object
Upload File
Load Checksum
Load Firmware
Load Firmware Checksum
Network Template Rendering System
Render Service
Filter quick reference
Template expansion
Healthcheck
Current User Info
List Consumers
Reset All Consumers
Get Consumer Info
Reset Consumer
Render All
Render Batch
Render
Network Infrastructure Automation with Temporal
Temporal Deployment Process
Temporal CLI
Workflows for Day 2 Operations
BMC Provisioning
Configuration Backup
Configuration Deploy
Connected Host Metadata
Device Cable Validation
Device Password Rotation
Device Reprovisioning
Hardware Validation
InfiniBand Cable Validation
Infiniband Get Unhealthy Ports
Infiniband MLNX OS Upgrade
IB PKey Creation
Multi-Deploy Workflow
NVLink Switch Firmware Upgrade
Port LLDP Info
Site Cable Validation
Site Password Rotation
Switch OS Upgrade
VPC Creation
VPC Deletion
InfiniBand PKey Member Add
InfiniBand PKey Member Update
InfiniBand PKey Member Delete
InfiniBand Port GUID Discovery
Temporal API
Healthcheck
RBAC Config Status
Current User Info
Decode payloads
Encode payloads
Get Devices
Get Device ID by Name
Get Device Password Users
Get Secret Types for Device
Get Device Secrets
Get Diagnostics Commands
Get Locations
Get Namespace Tags
Get Overlays
Get Roles
Get Sites
Get Statuses
Get Tenants
Get Workflows
Execute HelloWorld
Execute HelloWorldApproval
Get Workflow Metadata
Execute BackupWorkflow
Execute BatchDeployWorkflow
Execute ConnectedHostMetadataWorkflow
Execute ValidateHardwareWorkflow
Execute DeployWorkflow
Execute DeviceCableValidationWorkflow
Execute DevicePasswordRotationWorkflow
Execute DiagnosticsWorkflow
Execute IBPKeyCreationWorkflow
Execute IBPKeyMemberAddWorkflow
Execute IBPKeyMemberDeleteWorkflow
Execute IBPKeyMemberUpdateWorkflow
Execute IBPortGuidDiscoveryWorkflow
Execute InfinibandCableValidationWorkflow
Execute InfinibandGetUnhealthyPortsWorkflow
Execute InfinibandMlnxOSUpgradeWorkflow
Execute MultiDeployWorkflow
Execute NVLinkSwitchFirmwareUpgradeWorkflow
Execute PortLLDPInfoWorkflow
Execute RedfishProvisioningWorkflow
Execute ReprovisionWorkflow
Execute SiteCableValidationWorkflow
Execute SitePasswordRotationWorkflow
Execute SpXOverlayAssignmentWorkflow
Execute SpXOverlayCreationWorkflow
Execute SpXOverlayDeletionWorkflow
Execute SpXOverlayTenantChangeWorkflow
Execute SwitchOSUpgradeWorkflow
Execute TenantDeployWorkflow
Get Workflow Types
Get Workflow
Approve
Reject
Retry
Download Tech Support
Terminate

Services Network ZTP Service ZTP API

Healthcheck

||View as Markdown|

GET

///healthcheck

GET

/healthcheck

$ curl /healthcheck \
>      -H "Content-Type: application/json"

200Retrieved

1 "Service is operational"

Execute healthcheck.

Response

Successful Response

Developer-friendly docs for your API