> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.
# Get global hardware model (GET /v1/sysmodels/global/id/{id})
> GET /api/v1/sysmodels/global/id/{id}. Edge nodes API reference.
Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request.
> [accordion] Connect your console
>
> Sign in to your usual ZedCloud console, then open:
>
>
> - Profile menu
- Help & Documentation
- API Reference
>
>
> Your cluster and authorization are filled in automatically. No token to copy.
> [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference)
Modifying requests stay off until you enable them.
[Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/edge-node.json)
A successful response.
Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
Not Found. The API gateway did not process the request because the requested resource could not be found.
Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
An unexpected error response.
## OpenAPI
````yaml openapi/services/edge-node.json GET /v1/sysmodels/global/id/{id}
openapi: 3.0.0
info:
title: ZEDEDA Edge Node Service
description: >-
The ZEDEDA Edge Node Service is part of ZEDEDA Edge Orchestration Platform.
This service enables customers to onboard their edge nodes on ZEDEDA
platform and upgrade/restart/monitor them remotely. You can use the ZEDEDA
Edge Node Service to provision and manage lifecycle of millions of edge
nodes distributed in different geographical locations in a secure and
scalable manner.
termsOfService: https://www.zededa.com/terms
version: '1.0'
contact:
name: ZEDEDA API Support
url: https://www.zededa.com/support
email: support@zededa.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{apiHost}/api
variables:
apiHost:
default: invalid.invalid
description: Connect from ZedUI to supply your verified API destination.
security:
- BearerToken: []
tags:
- name: EdgeNodeConfiguration
- name: EdgeNodeStatus
- name: ResourceGroupStatus
- name: ResourceGroup
- name: HardwareModel
- name: CertificateEnrollmentProfileConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-nodes
paths:
/v1/sysmodels/global/id/{id}:
get:
tags:
- HardwareModel
summary: Get global hardware model
description: >-
Get the configuration (without security details) of a global hardware
model record.
operationId: HardwareModel_GetGlobalHardwareModel
parameters:
- name: id
description: System defined universally unique Id of the model
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/SysModel'
'401':
description: >-
Unauthorized. The API gateway did not process the request because it
lacks valid authentication credentials for the target resource. The
request header has either no authorization details or an
authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: >-
Forbidden. The API gateway did not process the request because the
requestor does not have edge-node level access permission for the
operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: >-
Not Found. The API gateway did not process the request because the
requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: >-
Internal Server Error. The API gateway experienced an unexpected
condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: >-
Gateway Timeout. The API gateway did not receive a timely response
from an upstream microservice it needed to communicate with in order
to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
components:
schemas:
SysModel:
type: object
properties:
id:
type: string
description: System defined universally unique Id of the model.
readOnly: true
pattern: >-
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
x-zededa-source-issues:
- code: inapplicable-constraint
pointer: '#/definitions/SysModel/properties/id'
keyword: uniqueItems
sourceValue: true
name:
type: string
description: user defined model name
maxLength: 256
minLength: 3
pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
title:
type: string
description: User defined title of the model. Title can be changed at any time.
maxLength: 256
minLength: 3
pattern: '[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+'
brandId:
type: string
description: System defined universally unique Id of the brand.
pattern: >-
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12
x-zededa-source-issues:
- code: inapplicable-constraint
pointer: '#/definitions/SysModel/properties/brandId'
keyword: uniqueItems
sourceValue: true
description:
type: string
description: Detailed description of the model.
maxLength: 256
state:
description: SysModel State which denotes the status of the model
allOf:
- $ref: '#/components/schemas/SysModelState'
revision:
description: Object Revision of the model
readOnly: true
allOf:
- $ref: '#/components/schemas/ObjectRevision'
type:
description: Defines the Architecture type of the model
allOf:
- $ref: '#/components/schemas/ModelArchType'
attr:
type: object
additionalProperties:
type: string
description: Map of which defines attr
productStatus:
type: string
description: Product status
productURL:
type: string
description: Product URL
brandName:
type: string
description: Brand name.
ioMemberList:
type: array
items:
$ref: '#/components/schemas/ioMember'
description: List of IoMembers
logo:
type: object
additionalProperties:
type: string
description: >-
Map of which holds the key:url for the logo
artifact of the model
parentDetail:
description: origin and parent related details
allOf:
- $ref: '#/components/schemas/ObjectParentDetail'
originType:
description: origin of object
allOf:
- $ref: '#/components/schemas/Origin'
PCRTemplates:
type: array
items:
$ref: '#/components/schemas/PCRTemplate'
description: PCR templates keyed by EVE version
isImported:
type: boolean
description: Flag to represent whether sysModel is imported
description: >-
SysModel consists of various model attributes like id, name, title,
brandId etc
title: SysModel payload details
required:
- name
- title
- brandId
- state
- type
- attr
- originType
ZsrvResponse:
type: object
properties:
operationType:
title: |-
Describes one of the operations type : possible values
Read/Delete/Create/Update/List
allOf:
- $ref: '#/components/schemas/ZcOpsType'
operationStatus:
title: if this is log running job
allOf:
- $ref: '#/components/schemas/ZcOpsStatus'
objectKind:
type: string
title: zedcloud object kind on which the operation was performed
objectId:
type: string
title: Unique value identifies the object that was operated on
objectName:
type: string
title: name of the object
objectRevision:
type: string
title: |-
object revision post the operation, note Read operation
doesn't change the revision
objectType:
$ref: '#/components/schemas/ObjectType'
operationTime:
type: string
title: time of operation
startTime:
type: string
title: total time taken by operations
endTime:
type: string
user:
type: string
title: the operation is performed on behalf of this user
httpStatusCode:
type: integer
format: int32
title: http response
httpStatusMsg:
type: string
title: summary of the error in text format
jobId:
type: string
title: for tracking asynchronous tasks
error:
type: array
items:
$ref: '#/components/schemas/ZsrvError'
title: |-
one or more errors will be set if the operation failed
i.e. httpStatusCode != 2xx
googlerpcStatus:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: '#/components/schemas/protobufAny'
SysModelState:
type: string
enum:
- SYS_MODEL_STATE_UNSPECIFIED
- SYS_MODEL_STATE_ARCHIVE
- SYS_MODEL_STATE_ACTIVE
default: SYS_MODEL_STATE_UNSPECIFIED
description: >-
- SYS_MODEL_STATE_UNSPECIFIED: default options, which says no
Operation/Invalid Operation
- SYS_MODEL_STATE_ARCHIVE: Archived sysModel State
- SYS_MODEL_STATE_ACTIVE: Active sysModel state
title: 'SysModelState : enum specifies the SysModel status'
ObjectRevision:
type: object
properties:
prev:
type: string
description: Previous
curr:
type: string
description: Current Database version of the record
createdAt:
type: object
format: date-time
description: >-
The time, in milliseconds since the epoch, when the record was
created.
createdBy:
type: string
description: 'User data: Created By'
updatedAt:
type: object
format: date-time
description: >-
The time, in milliseconds since the epoch, when the record was last
updated.
updatedBy:
type: string
description: 'User data: Updated By'
description: >-
ObjectRevision store the user details, who has doent the necessary
operation like Create Operation or update operation
title: ObjectRevision is used to store the user information.
required:
- curr
- createdAt
- createdBy
- updatedAt
- updatedBy
ModelArchType:
type: string
enum:
- UNSPECIFIED
- UNDEFINED
- AMD64
- ARM64
default: UNSPECIFIED
ioMember:
type: object
example:
ztype: 1
phylabel: eth0
logicallabel: eth0
properties:
ztype:
description: Z Type
allOf:
- $ref: '#/components/schemas/IoType'
phylabel:
type: string
description: Physical Label
phyaddrs:
type: object
additionalProperties:
type: string
description: Map of Physical Addresses
logicallabel:
type: string
description: Logical Label
assigngrp:
type: string
description: Assign Group
usage:
description: Adopter Usage
allOf:
- $ref: '#/components/schemas/AdapterUsage'
cbattr:
type: object
additionalProperties:
type: string
description: attributes
title: physical and logical attributes
usagePolicy:
type: object
additionalProperties:
type: boolean
title: usagePolicy
cost:
type: integer
format: int64
description: cost of using this ioMember. Default is 0.
maximum: 255
vfs:
title: >-
Single Root Input Output Virtualization (SR-IOV) support in device
configuration
allOf:
- $ref: '#/components/schemas/Vfs'
parentassigngrp:
type: string
description: >-
Parent group for a IoMember. Can be empty if there is no parent
group.
description: ' ioMember consists of list of various networking attributes like physical label, physical address etc associated with SysModel'
title: ioMember payload details
required:
- ztype
- phylabel
- assigngrp
- phyaddrs
- logicallabel
- cost
ObjectParentDetail:
type: object
properties:
idOfParentObject:
type: string
description: >-
system defined unique id of parent object
**Source definition issue:** required `["true"]` is not a valid
required-property list for this schema. It is not used to infer
required fields; the containing object's valid required list still
applies.
readOnly: true
pattern: '[0-9A-Za-z-]+'
x-zededa-source-issues:
- code: invalid-required
pointer: '#/definitions/ObjectParentDetail/properties/idOfParentObject'
keyword: required
sourceValue:
- 'true'
versionOfParentObject:
type: integer
format: int64
description: version of object present in parent
readOnly: true
pattern: '[0-9]+'
updateAvailable:
type: boolean
description: Update required flag
referenceExists:
type: boolean
description: Relation with child and parent object exists or not
description: >-
ObjectImportDetail consists of various object attributes like
idOfParentObject, versionOfParentObject, updateAvailable,
referenceExists
title: Object Import Detail
required:
- idOfParentObject
Origin:
type: string
enum:
- ORIGIN_UNSPECIFIED
- ORIGIN_IMPORTED
- ORIGIN_LOCAL
- ORIGIN_GLOBAL
- ORIGIN_APP_PROFILE_LOCAL
default: ORIGIN_UNSPECIFIED
description: >-
- ORIGIN_UNSPECIFIED: default options, which says no Operation/Invalid
Operation
- ORIGIN_IMPORTED: Object imported from global enterprise.
- ORIGIN_LOCAL: Objectl created locally.
- ORIGIN_GLOBAL: Object created in global store,
to use this type user should have root previlage.
- ORIGIN_APP_PROFILE_LOCAL: Object created via App profile
title: 'OriginType : enum specifies the Object orgigin type'
PCRTemplate:
type: object
properties:
eveVersion:
type: string
description: EVE version related to the PCR template
firmwareVersion:
type: string
description: >-
Firmware version related to the PCR template. If user doesn't set
it, it will be set to '*'
PCRValues:
type: array
items:
$ref: '#/components/schemas/PCRValue'
description: List of PCR values for the PCR template
id:
type: string
description: >-
System defined universally unique Id of the PCR template. If not set
in POST / PUT API calls, this will be treated as a new entry and a
unique System Generated ID assigned.
pattern: >-
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
x-zededa-source-issues:
- code: inapplicable-constraint
pointer: '#/definitions/PCRTemplate/properties/id'
keyword: uniqueItems
sourceValue: true
name:
type: string
description: >-
Name of the PCR template. The name is Unique among PCR templates for
that System Model. If it is not specified, a system-generated name
will be assigned.
maxLength: 256
description: PCR template data for the specified eve version and firmware version
title: PCR template
required:
- eveVersion
- PCRValues
ZcOpsType:
type: string
enum:
- OPS_TYPE_UNSPECIFIED
- OPS_TYPE_READ
- OPS_TYPE_DELETE
- OPS_TYPE_CREATE
- OPS_TYPE_UPDATE
- OPS_TYPE_LIST
default: OPS_TYPE_UNSPECIFIED
title: ZedCloud internal operation type
ZcOpsStatus:
type: string
enum:
- OPS_STATUS_UNSPECIFIED
- OPS_STATUS_PENDING
- OPS_STATUS_ONGOING
- OPS_STATUS_COMPLETE
default: OPS_STATUS_UNSPECIFIED
description: >-
- OPS_STATUS_PENDING: In rare cases, system may not start operation when
it was requested. Client will be notified that operation is PENDING
- OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.
- OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases.
title: ZedCloud internal operation status
ObjectType:
type: string
enum:
- OBJECT_TYPE_UNSPECIFIED
- OBJECT_TYPE_USER
- OBJECT_TYPE_EDGE_NODE
- OBJECT_TYPE_EDGE_APP
- OBJECT_TYPE_IMAGE
- OBJECT_TYPE_EDGE_APP_INSTANCE
- OBJECT_TYPE_PROJECT
- OBJECT_TYPE_NETWORK
- OBJECT_TYPE_DATASTORE
- OBJECT_TYPE_SERVICE
- OBJECT_TYPE_SERVICE_INSTANCE
- OBJECT_TYPE_ENTERPRISE
- OBJECT_TYPE_ROLE
- OBJECT_TYPE_CREDENTIAL
- OBJECT_TYPE_NETWORK_INSTANCE
- OBJECT_TYPE_VOLUME_INSTANCE
- OBJECT_TYPE_REALM
- OBJECT_TYPE_AUTHPROFILE
- OBJECT_TYPE_POLICY
- OBJECT_TYPE_APP_POLICY
- OBJECT_TYPE_CLUSTER_INSTANCE
- OBJECT_TYPE_PLUGIN
- OBJECT_TYPE_DOC_POLICY
- OBJECT_TYPE_ORCHESTRATOR_CLUSTER
- OBJECT_TYPE_TAGS
- OBJECT_TYPE_EDGE_NODE_INTERFACE
- OBJECT_TYPE_DEPLOYMENT
- OBJECT_TYPE_ENTITLEMENTS
- OBJECT_TYPE_DATA_STREAM
- OBJECT_TYPE_API_USAGE
- OBJECT_TYPE_APP_INSTANCE_SNAPSHOT
- OBJECT_TYPE_PATCH_ENVELOPE
- OBJECT_TYPE_RESOURCE_USAGE_TRACK
- OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE
- OBJECT_TYPE_DEV_PASSTHROUGH
- OBJECT_TYPE_EDGE_NODE_CLUSTER
- OBJECT_TYPE_ASSET_GROUP
- OBJECT_TYPE_APP_PROFILE
- OBJECT_TYPE_PROFILE_DEPLOYMENT
- OBJECT_TYPE_ZKS_INSTANCE
- OBJECT_TYPE_CLUSTER_GROUP
default: OBJECT_TYPE_UNSPECIFIED
ZsrvError:
type: object
properties:
ec:
title: |-
Enumrated error code, describes more granular numerical
value than just httpStatus
allOf:
- $ref: '#/components/schemas/ZsrvErrorCode'
location:
type: string
title: 'Ignore: Internal field only'
details:
type: string
title: Field captures string description of details
protobufAny:
type: object
properties:
typeUrl:
type: string
value:
type: string
format: byte
IoType:
type: string
enum:
- IO_TYPE_UNSPECIFIED
- IO_TYPE_ETH
- IO_TYPE_USB
- IO_TYPE_COM
- IO_TYPE_AUDIO
- IO_TYPE_WLAN
- IO_TYPE_WWAN
- IO_TYPE_HDMI
- IO_TYPE_LTE
- IO_TYPE_STORAGE_NVME_DEVICE
- IO_TYPE_STORAGE_SATA_DEVICE
- IO_TYPE_ETH_PF
- IO_TYPE_ETH_VF
- IO_TYPE_USB_CONTROLLER
- IO_TYPE_USB_DEVICE
- IO_TYPE_CAN
- IO_TYPE_VCAN
- IO_TYPE_LCAN
- IO_TYPE_VLAN
- IO_TYPE_OTHER
default: IO_TYPE_UNSPECIFIED
description: |-
- IO_TYPE_UNSPECIFIED: No operation/ Invalid peration
- IO_TYPE_ETH: Ethernet
- IO_TYPE_USB: USB Type - General
- IO_TYPE_COM: Communication Port
- IO_TYPE_AUDIO: Audio Port
- IO_TYPE_WLAN: wireless LAN
- IO_TYPE_WWAN: Wireless wide area network
- IO_TYPE_HDMI: High-Definition Multimedia Interface
- IO_TYPE_LTE: LTE Interfaces
- IO_TYPE_STORAGE_NVME_DEVICE: Storage NVME device
- IO_TYPE_STORAGE_SATA_DEVICE: Storage SATA device
- IO_TYPE_ETH_PF: Physical Interface (PF) of the Virtual Functions
- IO_TYPE_ETH_VF: Virtual Function (VF)
- IO_TYPE_USB_CONTROLLER: USB Type - Controller
- IO_TYPE_USB_DEVICE: USB Type - Device
- IO_TYPE_CAN: CAN - Device
- IO_TYPE_VCAN: VCAN - Virtual CAN device
- IO_TYPE_LCAN: LCAN - Logical CAN device
- IO_TYPE_VLAN: VLAN - Virtual LAN device
- IO_TYPE_OTHER: Other Io Types
title: Input/Output Type
AdapterUsage:
type: string
enum:
- ADAPTER_USAGE_UNSPECIFIED
- ADAPTER_USAGE_MANAGEMENT
- ADAPTER_USAGE_APP_DIRECT
- ADAPTER_USAGE_APP_SHARED
- ADAPTER_USAGE_DISABLED
- ADAPTER_USAGE_VLANS_ONLY
- ADAPTER_USAGE_BOND_MEMBER
default: ADAPTER_USAGE_UNSPECIFIED
description: |-
- ADAPTER_USAGE_UNSPECIFIED: Adapter unspecified
- ADAPTER_USAGE_MANAGEMENT: Adapter can be used by EVE as well as other Edge applications
- ADAPTER_USAGE_APP_DIRECT: Adapter is directly used by one edge application
- ADAPTER_USAGE_APP_SHARED: Adapter can be shared by different network instances
- ADAPTER_USAGE_DISABLED: Adapter disabled, for future use
- ADAPTER_USAGE_VLANS_ONLY: Adapter is used exclusively for VLANs
- ADAPTER_USAGE_BOND_MEMBER: Adapter is used exclusively for BOND interfaces
title: Adapter Usage
Vfs:
type: object
properties:
count:
type: integer
format: int64
description: >-
The number of Virtual Functions for given Physical Function. Only
applies for IO_TYPE_ETH_PF.
maximum: 255
PCRValue:
type: object
properties:
type:
description: >-
Type of value for the PCR item. Could be one of the following
values: 0 (PCR_TYPE_UNSPECIFIED), 1 (PCR_TYPE_HASH) or 2
(PCR_TYPE_EVENT_LOG)
allOf:
- $ref: '#/components/schemas/PCRType'
index:
type: number
format: int64
description: >-
Current index for the PCR item in the list. First element has the
index 0
value:
type: string
description: Actual value for the PCR item.
description: PCR value contains the actual value of the specified PCR type
title: PCR value
required:
- type
- index
- value
ZsrvErrorCode:
type: string
enum:
- zMsgErrorNone
- zMsgSucess
- NotFound
- AlreadyExists
- VersionMismatch
- RangeError
- LargeResult
- IncompleteData
- InvalidData
- FunctionUnsupported
- NoMemory
- SendFailure
- Timeout
- BadReqBody
- BadReqParam
- InvalidFieldFormat
- UrlNotFound
- ApiVersionNotSupported
- Unauthorized
- Forbidden
- Conflict
- NotModified
- DependencyConflict
- JsonFmtError
- ProtoFmtError
- CertError
- DataBaseConnection
- DBError
- zMsgAccepted
- zMsgCreated
- PreConditionFailed
- InternalServerError
default: zMsgErrorNone
description: |-
- zMsgErrorNone: common validation errors
- IncompleteData: message had fields that weren't filled in
- InvalidData: message contained the field that wasn't expected
- FunctionUnsupported: this feature unavailable on this version of device
- InvalidFieldFormat: message contained the field that wasn't correctly formatted
- JsonFmtError: Marshal / Unmarshal errors
- DataBaseConnection: generic DB error
title: ZedCould internal error code
PCRType:
type: string
enum:
- PCR_TYPE_UNSPECIFIED
- PCR_TYPE_HASH
- PCR_TYPE_EVENT_LOG
default: PCR_TYPE_UNSPECIFIED
title: |-
- PCR_TYPE_UNSPECIFIED: Unset PCR type
- PCR_TYPE_HASH: PCR value of type HASH
- PCR_TYPE_EVENT_LOG: PCR value of type event log
securitySchemes:
BearerToken:
type: http
description: Bearer token for user session
scheme: bearer
````