Skip to main content
PATCH
/
v1
/
devices
/
{id}
Update a device by id
curl --request PATCH \
  --url https://managexrapi.com/v1/devices/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Device_123",
  "configurationId": "AKDJF139UGNLA12J",
  "notes": "This device was recently moved on 9/15",
  "tagIds": [
    "KADJFL2U4T",
    "AKLU32OI2QU5U"
  ]
}
'
import requests

url = "https://managexrapi.com/v1/devices/{id}"

payload = {
"name": "Device_123",
"configurationId": "AKDJF139UGNLA12J",
"notes": "This device was recently moved on 9/15",
"tagIds": ["KADJFL2U4T", "AKLU32OI2QU5U"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Device_123',
configurationId: 'AKDJF139UGNLA12J',
notes: 'This device was recently moved on 9/15',
tagIds: ['KADJFL2U4T', 'AKLU32OI2QU5U']
})
};

fetch('https://managexrapi.com/v1/devices/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://managexrapi.com/v1/devices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Device_123',
'configurationId' => 'AKDJF139UGNLA12J',
'notes' => 'This device was recently moved on 9/15',
'tagIds' => [
'KADJFL2U4T',
'AKLU32OI2QU5U'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://managexrapi.com/v1/devices/{id}"

payload := strings.NewReader("{\n \"name\": \"Device_123\",\n \"configurationId\": \"AKDJF139UGNLA12J\",\n \"notes\": \"This device was recently moved on 9/15\",\n \"tagIds\": [\n \"KADJFL2U4T\",\n \"AKLU32OI2QU5U\"\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://managexrapi.com/v1/devices/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Device_123\",\n \"configurationId\": \"AKDJF139UGNLA12J\",\n \"notes\": \"This device was recently moved on 9/15\",\n \"tagIds\": [\n \"KADJFL2U4T\",\n \"AKLU32OI2QU5U\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://managexrapi.com/v1/devices/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Device_123\",\n \"configurationId\": \"AKDJF139UGNLA12J\",\n \"notes\": \"This device was recently moved on 9/15\",\n \"tagIds\": [\n \"KADJFL2U4T\",\n \"AKLU32OI2QU5U\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "statusCode": 403,
  "message": "Forbidden",
  "error": "ManageXR Error"
}
{
"statusCode": 404,
"message": "Not found error",
"error": "ManageXR Error"
}

Authorizations

Authorization
string
header
required

API key based authentication where is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

  • Username: The API Key ID.
  • Password: The API Key Secret.

Path Parameters

id
string
required

Unique identifier (serial number) of the device

Query Parameters

organizationId
string

Unique identifier of the organization. This parameter is only necessary when using multi-organization API keys.

Defaults to the organizationId associated with the API key.

Body

application/json
name
string

Name of the device

Example:

"Device_123"

configurationId
string

ID of new configuration to assign to the device

Example:

"AKDJF139UGNLA12J"

notes
string

Device notes

Example:

"This device was recently moved on 9/15"

tagIds
string[]

Ids of tags to apply to device

Example:
["KADJFL2U4T", "AKLU32OI2QU5U"]

Response

Success