curl --request GET \
--url https://api.example.com/api/v1/devices/list-all-ids/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/devices/list-all-ids/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/devices/list-all-ids/', 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/list-all-ids/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/devices/list-all-ids/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/devices/list-all-ids/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/devices/list-all-ids/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]{
"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>"
]
}
]
}List device IDs
Return device IDs for a site, with the same filters as the device list endpoint.
Requires site_id to scope the response (matching the compact
list-all endpoint) and additionally accepts every DeviceFilter
query parameter the paginated list supports. Returns an unpaginated array
of matching device IDs, capped by LIST_ALL_MAX_RESULTS.
curl --request GET \
--url https://api.example.com/api/v1/devices/list-all-ids/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/devices/list-all-ids/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/devices/list-all-ids/', 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/list-all-ids/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/devices/list-all-ids/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/devices/list-all-ids/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/devices/list-all-ids/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Multiple values may be separated by commas.
Filter by annotation key=value pairs (AND semantics). Use annotation_eq[key]=value.
Show child attributes
Show child attributes
Filter by annotation key existence (comma-separated, AND semantics).
Multiple values may be separated by commas.
Multiple values may be separated by commas.
cpu_baremetal, cpu_hypervisor, gpu_compute, switch Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
critical, degraded, healthy, unknown Multiple values may be separated by commas.
active, decommissioned, decommissioning, failed, inventory, offline, planned, returned, rma, staged, unknown Multiple values may be separated by commas.
active, adopt failed, adopting, available, clean failed, clean hold, clean wait, cleaning, deleted, deleting, deploy complete, deploy failed, deploy hold, deploying, enroll, error, inspect failed, inspect wait, inspecting, manageable, rebuild, rescue, rescue failed, rescue wait, rescuing, service, service failed, service hold, service wait, servicing, unknown, unrescue failed, unrescuing, verifying, wait call-back Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
available, delegated, drained, failed, in_use, pending_handover, quarantine, unknown, validation Multiple values may be separated by commas.
Multiple values may be separated by commas.
Site ID used to constrain the unpaginated compact response.
SLURM node states. A device matches when its own state list contains any of these. Multiple values may be separated by commas.
ALLOCATED, BLOCKED, CLOUD, COMPLETING, DOWN, DRAIN, DYNAMIC_FUTURE, DYNAMIC_NORM, ERROR, FAIL, FUTURE, IDLE, INVALID_REG, MAINTENANCE, MIXED, NOT_RESPONDING, PLANNED, POWERED_DOWN, POWERING_DOWN, POWERING_UP, POWER_DOWN, POWER_DRAIN, POWER_UP, REBOOT_CANCELED, REBOOT_ISSUED, REBOOT_REQUESTED, RESERVED, RESUME, UNDRAIN, UNKNOWN Filter by tags (comma-separated, OR semantics).
Multiple values may be separated by commas.
Multiple values may be separated by commas.