Updates a device (server object).

Send a JSON object in the request body to update device details. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
id
required
integer <int64>

Server ID for the specified device.

query Parameters
o
required
integer <int64>

Organization ID for the specified device.

Request Body schema: application/json
required
server_group_id
required
integer <int64>

Server Group ID for the specified group.

ip_addrs
Array of strings

Server IP addresses.

exception
required
boolean

Use the exception property to exclude the device from reports and statistics.

tags
Array of strings

List of tags.

custom_name
string

Custom name that will display in the console instead of the hostname.

Responses
204

Update Successful

401

Access token is missing or invalid

403

You do not have permission to perform this action.

429

Too many requests

503

Service Unavailable

default

Invalid Request

put/servers/{id}
Request samples
application/json
{
  • "summary": "Device update request example",
  • "description": "Example request for updating device configuration with server group assignment",
  • "value": {
    • "server_group_id": 156203,
    • "exception": false
    }
}
Response samples
application/json
{
  • "errors": [
    • "string"
    ]
}