Update Hostname

Time	Status	User Agent
Retrieving recent requests…

Overview

Updates the IP / Hostname address an edge device is reachable on. The new address is synced to the Edge monitoring configuration and stored on the device. The device's custom parameter values are preserved.

Unless skip_connectivity_check is true, a successful connectivity check for the new address must be performed first — see Start Ping and Get Ping Status.

Authorization

This endpoint requires Authorization.

Path Parameters

Key	Type	Description	Required
device_id	string	Unique device UUID.	Yes

Request Body

Key	Type	Description	Required
device_ip	string	New IP / Hostname address of the device.	Yes
skip_connectivity_check	boolean	Skip the connectivity check for the new address. Defaults to `false`.	No

{
  "device_ip": "192.168.1.100",
  "skip_connectivity_check": false
}

Response

200 OK

{
  "success": true
}

Errors

Status	Description
400	Missing `device_ip`, or the new address has not passed a connectivity check.
401	Missing or invalid `Authorization` header.
404	Device not found in the organization.
422	Malformed `device_ip` (only letters, digits, dots, and hyphens are allowed).