Update device

curl --request PUT \
  --url https://api.example.com/api/v1/devices/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "netbox_link": "<string>",
  "name": "<string>",
  "position": "<string>",
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "serial_number": "<string>",
  "infrastructure_ref": "<string>",
  "placement_traits": [
    "<string>"
  ],
  "slurm_states": [],
  "slurm_state_updated_at": "2023-11-07T05:31:56Z",
  "slurm_state_reason": "<string>",
  "operational_failure_reason": "<string>",
  "operational_failure_details": "<string>",
  "ironic_maintenance": true,
  "ironic_maintenance_reason": "<string>",
  "ironic_fault": "<string>",
  "ironic_last_error": "<string>",
  "triage_ticket_url": "<string>",
  "parent_ticket_url": "<string>",
  "netbox_id": 1073741823,
  "netbox_source_updated_at": "2023-11-07T05:31:56Z",
  "interfaces": [
    {
      "name": "<string>",
      "type": "<string>",
      "type_display": "<string>",
      "ip_addresses": [
        "<string>"
      ],
      "mac_address": "<string>",
      "ib_device_guid": "<string>"
    }
  ],
  "platform_class": "<string>",
  "entered_service_at": "2023-11-07T05:31:56Z",
  "in_triage": true,
  "chad_ignore": true
}
'

import requests

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

payload = {
    "netbox_link": "<string>",
    "name": "<string>",
    "position": "<string>",
    "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "annotations": {},
    "tags": ["<string>"],
    "serial_number": "<string>",
    "infrastructure_ref": "<string>",
    "placement_traits": ["<string>"],
    "slurm_states": [],
    "slurm_state_updated_at": "2023-11-07T05:31:56Z",
    "slurm_state_reason": "<string>",
    "operational_failure_reason": "<string>",
    "operational_failure_details": "<string>",
    "ironic_maintenance": True,
    "ironic_maintenance_reason": "<string>",
    "ironic_fault": "<string>",
    "ironic_last_error": "<string>",
    "triage_ticket_url": "<string>",
    "parent_ticket_url": "<string>",
    "netbox_id": 1073741823,
    "netbox_source_updated_at": "2023-11-07T05:31:56Z",
    "interfaces": [
        {
            "name": "<string>",
            "type": "<string>",
            "type_display": "<string>",
            "ip_addresses": ["<string>"],
            "mac_address": "<string>",
            "ib_device_guid": "<string>"
        }
    ],
    "platform_class": "<string>",
    "entered_service_at": "2023-11-07T05:31:56Z",
    "in_triage": True,
    "chad_ignore": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    netbox_link: '<string>',
    name: '<string>',
    position: '<string>',
    device_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    role: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    rack: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    annotations: {},
    tags: ['<string>'],
    serial_number: '<string>',
    infrastructure_ref: '<string>',
    placement_traits: ['<string>'],
    slurm_states: [],
    slurm_state_updated_at: '2023-11-07T05:31:56Z',
    slurm_state_reason: '<string>',
    operational_failure_reason: '<string>',
    operational_failure_details: '<string>',
    ironic_maintenance: true,
    ironic_maintenance_reason: '<string>',
    ironic_fault: '<string>',
    ironic_last_error: '<string>',
    triage_ticket_url: '<string>',
    parent_ticket_url: '<string>',
    netbox_id: 1073741823,
    netbox_source_updated_at: '2023-11-07T05:31:56Z',
    interfaces: [
      {
        name: '<string>',
        type: '<string>',
        type_display: '<string>',
        ip_addresses: ['<string>'],
        mac_address: '<string>',
        ib_device_guid: '<string>'
      }
    ],
    platform_class: '<string>',
    entered_service_at: '2023-11-07T05:31:56Z',
    in_triage: true,
    chad_ignore: true
  })
};

fetch('https://api.example.com/api/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://api.example.com/api/v1/devices/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'netbox_link' => '<string>',
    'name' => '<string>',
    'position' => '<string>',
    'device_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'role' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'rack' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'annotations' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'serial_number' => '<string>',
    'infrastructure_ref' => '<string>',
    'placement_traits' => [
        '<string>'
    ],
    'slurm_states' => [
        
    ],
    'slurm_state_updated_at' => '2023-11-07T05:31:56Z',
    'slurm_state_reason' => '<string>',
    'operational_failure_reason' => '<string>',
    'operational_failure_details' => '<string>',
    'ironic_maintenance' => true,
    'ironic_maintenance_reason' => '<string>',
    'ironic_fault' => '<string>',
    'ironic_last_error' => '<string>',
    'triage_ticket_url' => '<string>',
    'parent_ticket_url' => '<string>',
    'netbox_id' => 1073741823,
    'netbox_source_updated_at' => '2023-11-07T05:31:56Z',
    'interfaces' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'type_display' => '<string>',
                'ip_addresses' => [
                                '<string>'
                ],
                'mac_address' => '<string>',
                'ib_device_guid' => '<string>'
        ]
    ],
    'platform_class' => '<string>',
    'entered_service_at' => '2023-11-07T05:31:56Z',
    'in_triage' => true,
    'chad_ignore' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.example.com/api/v1/devices/{id}/"

	payload := strings.NewReader("{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.example.com/api/v1/devices/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nvswitch_rack_slot": "ST0",
  "nvswitch_switch_role": "",
  "nvswitch_nvos_hostname": "<string>",
  "enrollment_validated_ref": "<string>",
  "current_instance_uuid": "<string>",
  "device_type_kind": "<string>",
  "device_type_vendor": "<string>",
  "device_type_model": "<string>",
  "device_type_resource_class": "<string>",
  "role_name": "<string>",
  "role_slug": "<string>",
  "device_class": "gpu_compute",
  "rack_name": "<string>",
  "rack_serial_number": "",
  "location_name": "<string>",
  "site_name": "<string>",
  "site_slug": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_slug": "<string>",
  "links": {
    "self": "<string>",
    "collection": "<string>",
    "device_type": "<string>",
    "role": "<string>",
    "rack": "<string>",
    "location": "<string>",
    "site": "<string>",
    "jobs": "<string>",
    "job_device_statuses": "<string>",
    "netbox": "<string>"
  },
  "customer_ready": true,
  "topology": {},
  "topology_group_types": {},
  "short_name": "<string>",
  "current_tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_tenant_name": "<string>",
  "current_allocation_annotations": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "nvswitch_ztp_completed_at": "2023-11-07T05:31:56Z",
  "nvswitch_ztp_evidence_source": "<string>",
  "position": "<string>",
  "enrollment_proof_source": "enrolled",
  "entered_triage_at": "2023-11-07T05:31:56Z",
  "inventory_only": true,
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "serial_number": "<string>",
  "infrastructure_ref": "<string>",
  "ironic_provision_state": "enroll",
  "placement_traits": [
    "<string>"
  ],
  "slurm_states": [
    "ALLOCATED"
  ],
  "slurm_state_updated_at": "2023-11-07T05:31:56Z",
  "slurm_state_reason": "<string>",
  "operational_failure_reason": "<string>",
  "operational_failure_details": "<string>",
  "ironic_maintenance": true,
  "ironic_maintenance_reason": "<string>",
  "ironic_fault": "<string>",
  "ironic_last_error": "<string>",
  "triage_ticket_url": "<string>",
  "parent_ticket_url": "<string>",
  "netbox_id": 1073741823,
  "interfaces": [
    {
      "name": "<string>",
      "type": "<string>",
      "type_display": "<string>",
      "ip_addresses": [
        "<string>"
      ],
      "mac_address": "<string>",
      "ib_device_guid": "<string>"
    }
  ],
  "inventory_status": "planned",
  "operational_status": "unknown",
  "health_status": "unknown",
  "platform_class": "<string>",
  "entered_service_at": "2023-11-07T05:31:56Z",
  "in_triage": true,
  "chad_ignore": true
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

PUT

api

devices

{id}

Update device

curl --request PUT \
  --url https://api.example.com/api/v1/devices/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "netbox_link": "<string>",
  "name": "<string>",
  "position": "<string>",
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "serial_number": "<string>",
  "infrastructure_ref": "<string>",
  "placement_traits": [
    "<string>"
  ],
  "slurm_states": [],
  "slurm_state_updated_at": "2023-11-07T05:31:56Z",
  "slurm_state_reason": "<string>",
  "operational_failure_reason": "<string>",
  "operational_failure_details": "<string>",
  "ironic_maintenance": true,
  "ironic_maintenance_reason": "<string>",
  "ironic_fault": "<string>",
  "ironic_last_error": "<string>",
  "triage_ticket_url": "<string>",
  "parent_ticket_url": "<string>",
  "netbox_id": 1073741823,
  "netbox_source_updated_at": "2023-11-07T05:31:56Z",
  "interfaces": [
    {
      "name": "<string>",
      "type": "<string>",
      "type_display": "<string>",
      "ip_addresses": [
        "<string>"
      ],
      "mac_address": "<string>",
      "ib_device_guid": "<string>"
    }
  ],
  "platform_class": "<string>",
  "entered_service_at": "2023-11-07T05:31:56Z",
  "in_triage": true,
  "chad_ignore": true
}
'

import requests

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

payload = {
    "netbox_link": "<string>",
    "name": "<string>",
    "position": "<string>",
    "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "annotations": {},
    "tags": ["<string>"],
    "serial_number": "<string>",
    "infrastructure_ref": "<string>",
    "placement_traits": ["<string>"],
    "slurm_states": [],
    "slurm_state_updated_at": "2023-11-07T05:31:56Z",
    "slurm_state_reason": "<string>",
    "operational_failure_reason": "<string>",
    "operational_failure_details": "<string>",
    "ironic_maintenance": True,
    "ironic_maintenance_reason": "<string>",
    "ironic_fault": "<string>",
    "ironic_last_error": "<string>",
    "triage_ticket_url": "<string>",
    "parent_ticket_url": "<string>",
    "netbox_id": 1073741823,
    "netbox_source_updated_at": "2023-11-07T05:31:56Z",
    "interfaces": [
        {
            "name": "<string>",
            "type": "<string>",
            "type_display": "<string>",
            "ip_addresses": ["<string>"],
            "mac_address": "<string>",
            "ib_device_guid": "<string>"
        }
    ],
    "platform_class": "<string>",
    "entered_service_at": "2023-11-07T05:31:56Z",
    "in_triage": True,
    "chad_ignore": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    netbox_link: '<string>',
    name: '<string>',
    position: '<string>',
    device_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    role: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    rack: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    annotations: {},
    tags: ['<string>'],
    serial_number: '<string>',
    infrastructure_ref: '<string>',
    placement_traits: ['<string>'],
    slurm_states: [],
    slurm_state_updated_at: '2023-11-07T05:31:56Z',
    slurm_state_reason: '<string>',
    operational_failure_reason: '<string>',
    operational_failure_details: '<string>',
    ironic_maintenance: true,
    ironic_maintenance_reason: '<string>',
    ironic_fault: '<string>',
    ironic_last_error: '<string>',
    triage_ticket_url: '<string>',
    parent_ticket_url: '<string>',
    netbox_id: 1073741823,
    netbox_source_updated_at: '2023-11-07T05:31:56Z',
    interfaces: [
      {
        name: '<string>',
        type: '<string>',
        type_display: '<string>',
        ip_addresses: ['<string>'],
        mac_address: '<string>',
        ib_device_guid: '<string>'
      }
    ],
    platform_class: '<string>',
    entered_service_at: '2023-11-07T05:31:56Z',
    in_triage: true,
    chad_ignore: true
  })
};

fetch('https://api.example.com/api/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://api.example.com/api/v1/devices/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'netbox_link' => '<string>',
    'name' => '<string>',
    'position' => '<string>',
    'device_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'role' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'rack' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'annotations' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'serial_number' => '<string>',
    'infrastructure_ref' => '<string>',
    'placement_traits' => [
        '<string>'
    ],
    'slurm_states' => [
        
    ],
    'slurm_state_updated_at' => '2023-11-07T05:31:56Z',
    'slurm_state_reason' => '<string>',
    'operational_failure_reason' => '<string>',
    'operational_failure_details' => '<string>',
    'ironic_maintenance' => true,
    'ironic_maintenance_reason' => '<string>',
    'ironic_fault' => '<string>',
    'ironic_last_error' => '<string>',
    'triage_ticket_url' => '<string>',
    'parent_ticket_url' => '<string>',
    'netbox_id' => 1073741823,
    'netbox_source_updated_at' => '2023-11-07T05:31:56Z',
    'interfaces' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'type_display' => '<string>',
                'ip_addresses' => [
                                '<string>'
                ],
                'mac_address' => '<string>',
                'ib_device_guid' => '<string>'
        ]
    ],
    'platform_class' => '<string>',
    'entered_service_at' => '2023-11-07T05:31:56Z',
    'in_triage' => true,
    'chad_ignore' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.example.com/api/v1/devices/{id}/"

	payload := strings.NewReader("{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.example.com/api/v1/devices/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"netbox_link\": \"<string>\",\n  \"name\": \"<string>\",\n  \"position\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rack\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"serial_number\": \"<string>\",\n  \"infrastructure_ref\": \"<string>\",\n  \"placement_traits\": [\n    \"<string>\"\n  ],\n  \"slurm_states\": [],\n  \"slurm_state_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"slurm_state_reason\": \"<string>\",\n  \"operational_failure_reason\": \"<string>\",\n  \"operational_failure_details\": \"<string>\",\n  \"ironic_maintenance\": true,\n  \"ironic_maintenance_reason\": \"<string>\",\n  \"ironic_fault\": \"<string>\",\n  \"ironic_last_error\": \"<string>\",\n  \"triage_ticket_url\": \"<string>\",\n  \"parent_ticket_url\": \"<string>\",\n  \"netbox_id\": 1073741823,\n  \"netbox_source_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"interfaces\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"type_display\": \"<string>\",\n      \"ip_addresses\": [\n        \"<string>\"\n      ],\n      \"mac_address\": \"<string>\",\n      \"ib_device_guid\": \"<string>\"\n    }\n  ],\n  \"platform_class\": \"<string>\",\n  \"entered_service_at\": \"2023-11-07T05:31:56Z\",\n  \"in_triage\": true,\n  \"chad_ignore\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nvswitch_rack_slot": "ST0",
  "nvswitch_switch_role": "",
  "nvswitch_nvos_hostname": "<string>",
  "enrollment_validated_ref": "<string>",
  "current_instance_uuid": "<string>",
  "device_type_kind": "<string>",
  "device_type_vendor": "<string>",
  "device_type_model": "<string>",
  "device_type_resource_class": "<string>",
  "role_name": "<string>",
  "role_slug": "<string>",
  "device_class": "gpu_compute",
  "rack_name": "<string>",
  "rack_serial_number": "",
  "location_name": "<string>",
  "site_name": "<string>",
  "site_slug": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_slug": "<string>",
  "links": {
    "self": "<string>",
    "collection": "<string>",
    "device_type": "<string>",
    "role": "<string>",
    "rack": "<string>",
    "location": "<string>",
    "site": "<string>",
    "jobs": "<string>",
    "job_device_statuses": "<string>",
    "netbox": "<string>"
  },
  "customer_ready": true,
  "topology": {},
  "topology_group_types": {},
  "short_name": "<string>",
  "current_tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_tenant_name": "<string>",
  "current_allocation_annotations": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "nvswitch_ztp_completed_at": "2023-11-07T05:31:56Z",
  "nvswitch_ztp_evidence_source": "<string>",
  "position": "<string>",
  "enrollment_proof_source": "enrolled",
  "entered_triage_at": "2023-11-07T05:31:56Z",
  "inventory_only": true,
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rack": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "serial_number": "<string>",
  "infrastructure_ref": "<string>",
  "ironic_provision_state": "enroll",
  "placement_traits": [
    "<string>"
  ],
  "slurm_states": [
    "ALLOCATED"
  ],
  "slurm_state_updated_at": "2023-11-07T05:31:56Z",
  "slurm_state_reason": "<string>",
  "operational_failure_reason": "<string>",
  "operational_failure_details": "<string>",
  "ironic_maintenance": true,
  "ironic_maintenance_reason": "<string>",
  "ironic_fault": "<string>",
  "ironic_last_error": "<string>",
  "triage_ticket_url": "<string>",
  "parent_ticket_url": "<string>",
  "netbox_id": 1073741823,
  "interfaces": [
    {
      "name": "<string>",
      "type": "<string>",
      "type_display": "<string>",
      "ip_addresses": [
        "<string>"
      ],
      "mac_address": "<string>",
      "ib_device_guid": "<string>"
    }
  ],
  "inventory_status": "planned",
  "operational_status": "unknown",
  "health_status": "unknown",
  "platform_class": "<string>",
  "entered_service_at": "2023-11-07T05:31:56Z",
  "in_triage": true,
  "chad_ignore": true
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string<uuid>

required

A UUID string identifying this device.

Body

Serializer for Device model.

netbox_link

string<uri>

required

write-only

Maximum string length: 200

name

string

required

Maximum string length: 255

Pattern: ^[A-Za-z0-9._-]+$

position

string<decimal> | null

required

Rack U position. Null for an unpositioned device, one NetBox has in its rack without a U.

Pattern: ^-?\d{0,3}(?:\.\d{0,1})?$

device_type

string<uuid>

required

role

string<uuid>

required

rack

string<uuid>

required

annotations

object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

Show child attributes

Response

Serializer for Device model.

string<uuid>

required

read-only

nvswitch_rack_slot

enum<string> | null

required

ST0 - ST0
ST1 - ST1
ST2 - ST2
ST3 - ST3
ST4 - ST4
ST5 - ST5
ST6 - ST6
ST7 - ST7
ST8 - ST8

Available options:

ST0,

ST1,

ST2,

ST3,

ST4,

ST5,

ST6,

ST7,

ST8

nvswitch_switch_role

enum<string>

required

`` - Unset
lead - Lead
member - Member

Available options:

lead,

member

nvswitch_nvos_hostname

string

required

read-only

Maximum string length: 255

enrollment_validated_ref

string | null

required

read-only

current_instance_uuid

string | null

required

read-only

device_type_kind

string

required

read-only

device_type_vendor

string

required

read-only

device_type_model

string

required

read-only

device_type_resource_class

string

required

read-only

role_name

string

required

read-only

role_slug

string

required

read-only

Pattern: ^[-a-zA-Z0-9_]+$

device_class

enum<string>

required

gpu_compute - GPU Compute
cpu_hypervisor - CPU Hypervisor
cpu_baremetal - CPU Baremetal
switch - Switch

Available options:

gpu_compute,

cpu_hypervisor,

cpu_baremetal,

switch

rack_name

string

required

read-only

rack_serial_number

string

default:""

required

read-only

Rack serial number for this device's rack. Empty string if not synced.

location_name

string

required

read-only

site_name

string

required

read-only

site_slug

string

required

read-only

Pattern: ^[-a-zA-Z0-9_]+$

organisation_id

string<uuid>

required

read-only

organisation_slug

string

required

read-only

Pattern: ^[-a-zA-Z0-9_]+$

links

object

required

Serializer for device links.

Show child attributes

customer_ready

boolean

required

read-only

Compute customer_ready based on status fields.

topology

object

required

read-only

Return topology paths keyed by facet.

Show child attributes

topology_group_types

object

required

read-only

Return topology as {facet: {type: label}} using cached path_types/path_labels.

Enables type-aware lookup (e.g. find the "pod" label within "networking") even when the device is a member of a deeper group like "nvlink-domain". No extra queries — both path_types and path_labels are cached JSON fields on TopologyGroup.

Show child attributes

short_name

string

required

read-only

Extract short device identifier from full name.

Takes the last hyphen-separated segment (e.g. "gpu1255" from "sta1-p-phy-gpu1255"). Falls back to the full name if the segment doesn't contain both letters and digits.

current_tenant_id

string<uuid> | null

required

read-only

current_tenant_name

string | null

required

read-only

current_allocation_annotations

object | null

required

read-only

UNI region annotations from the device's active allocation.

Show child attributes

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

name

string

required

Maximum string length: 255

Pattern: ^[A-Za-z0-9._-]+$

nvswitch_ztp_completed_at

string<date-time> | null

required

read-only

nvswitch_ztp_evidence_source

string

required

read-only

e.g. netbox_tag, network_api, manual

position

string<decimal> | null

required

Rack U position. Null for an unpositioned device, one NetBox has in its rack without a U.

Pattern: ^-?\d{0,3}(?:\.\d{0,1})?$

enrollment_proof_source

enum<string>

required

Provenance of the current enrollment identity proof.

enrolled - Enrolled
legacy - Legacy
unmigrated - Unmigrated
none - None

Available options:

enrolled,

legacy,

unmigrated,

none

entered_triage_at

string<date-time> | null

required

read-only

inventory_only

boolean

required

read-only

device_type

string<uuid>

required

role

string<uuid>

required

rack

string<uuid>

required

location

string<uuid>

required

read-only

site

string<uuid>

required

read-only

annotations

object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

Show child attributes

Start Here

Operator Guide

Developer Guide

Relationships

Deployment Guide

Archived

API Reference

Update device

Authorizations

Path Parameters

Body

Response