Skip to main content
Get edge node PCR attestation
Authentication · API availability · Download OpenAPI

Authorizations

Authorization
string
header
required

Bearer token for user session

Headers

X-Request-Id
string

User-Agent specified id to track a request

Path Parameters

id
string
required

system generated unique id for a device

Response

A successful response.

Device Configuration request payload holds the device properties

name
string
required

user specified device name

title
string
required

user specified title

projectId
string
required

project name

modelId
string
required

device model

id
string
read-only

system generated unique id for a device

Pattern: [0-9A-Za-z-]+
description
string

user specified description

revision
ObjectRevision is used to store the user information. · object

Object revision details

tags
object

Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.

utype
enum<string>
default:UNSPECIFIED

device model arch type

Available options:
UNSPECIFIED,
UNDEFINED,
AMD64,
ARM64
serialno
string

Device serial number

location
string

Device location: deprecated

cpu
number<int64>

CPU (configured values)

thread
number<int64>

Threads

memory
number<int64>

Device memory in MBs

storage
number<int64>

Device storage in GBs

onboarding
DeviceCerts payload detail · object

Device level certificates used while onboarding

identity
string<byte>

Device identity

obkey
string

Object key

token
string

Single use token

clientIp
string

Client IP

dlisp
DeviceLisp payload detail · object

device Lisp

clusterID
string

System defined universally unique clusterInstance ID, unique across the enterprise.

Required string length: 3 - 256
Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+
adminState
enum<string>
default:ADMIN_STATE_UNSPECIFIED

administrative state of device

Source definition conflict: this property declares type "object", while the referenced definition declares "string". The referenced schema is shown; the conflicting declaration needs correction in ZEDEDA's Swagger definition.

Available options:
ADMIN_STATE_UNSPECIFIED,
ADMIN_STATE_CREATED,
ADMIN_STATE_DELETED,
ADMIN_STATE_ACTIVE,
ADMIN_STATE_INACTIVE,
ADMIN_STATE_REGISTERED,
ADMIN_STATE_ARCHIVED,
ADMIN_STATE_DELETION_PENDING
resetCounter
number<int64>

devicereset counter

resetTime
string

device reset time

baseImage
Base OS image payload detail · object[]

base images

configItem
EDConfigItem payload detail · object[]

ED configurations

deprecated
string

deprecated field

vlanAdapters
vlanAdapter payload detail · object[]

A list of VLAN sub-interfaces configured for EVE management traffic and for local network instances

interfaces
sysInterface payload detail · object[]

System Interface list

devLocation
Geographic location of an edge node · object

User specified geo location

sitePictures
string[]

Site captured pictures

assetId
string

Device asset ID

baseOsRetryCounter
number<int64>

device baseos retry counter

baseOsRetryTime
string

device baseos retry time

debugKnob
Device debug knob configuration · object

debug knob details for the device

defaultNetInst
Network instance detailed configuration · object

default network instance details

preparePowerOffCounter
number<int64>

prepare poweroff counter

preparePowerOffTime
string

prepare poweroff time

edgeviewconfig
object

edgeview configuration for device

generateSoftSerial
boolean

indicates whether a soft serial should be generated; it will work ONLY when device is created

deploymentTag
string

user defined tag for the device, which is used while deploying policies.

localOperatorConsoleURL
string

local operator console url

configLock
enum<string>
default:DEVICE_CONFIG_LOCK_UNSPECIFIED

device configuration lock setting

Available options:
DEVICE_CONFIG_LOCK_UNSPECIFIED,
DEVICE_CONFIG_LOCK_ENABLED,
DEVICE_CONFIG_LOCK_DISABLED
edgeviewAllow
boolean

Allow device to enable Edgeview

clusterInterface
string

Cluster Interface

edgeNodeCluster
object

Edge Node Cluster Configuration

baseOsForceUpgrade
boolean

Force upgrade base OS

project
Project details · object

Project specific info

model
Model details · object

Model specific info

edgeSyncConfig
object

edge sync config

pcrPolicy
Policy detailed configuration for a resource group (project) · object

PCR policy for TPM key sealing on this specific device (overrides project policy)

bondAdapter
bondAdapter payload detail · object[]

A list of bond interfaces