Zededa ResourceGroup API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ResourceGroup. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
18 operations
across 11 paths,
and defines 165 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, /api.
The identity and technical contract details declared by the specification.
LimitParams
object
3 properties
ProbeConfig
object
Probing configuration
5 properties
SymmetricKeyEnrollmentDetail
object
3 properties
PortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on all devices of the project
5 properties
AppInstPolicy
object
2 properties
VariableGroupConditionOperator
string
AppAccessPolicy
object
1 property
EnrollmentType
string
enrollment types.
SendDeviceMetrics
string
SendDeviceMetrics controls whether device metrics are sent to the cloud for devices in a project. - SENDDEVICEMETRICSUNSPECIFIED: Default value. Setting is not…
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
VolumeInstanceType
string
AppInstanceLogs
object
App Instance Logs configuration
1 property
1 required
ModulePolicy
object
list of modules that will be provisioned on all the devices of the project to which this policy is attached
11 properties
2 required
PolicyConfig
object
Policy configuration defines set of policies to be applied on a resource grup (project). Policy can be one of the types specified in PolicyType. Multiple polic…
20 properties
3 required
DhcpServerConfig
object
8 properties
LispServer
object
LispServer request payload
2 properties
2 required
ZsrvResponse
object
15 properties
ClusterConfig
object
1 property
ObjectTag
object
Object tag deaails.
3 properties
VolumeInstPolicy
object
2 properties
protobufAny
object
2 properties
GroupCertificateEnrollment
object
1 property
MetricQueryResponseItem
object
2 properties
NetworkPolicy
object
list of networks that will be created on all the devices of the project to which this policy is attached
1 property
1 required
ZsrvError
object
3 properties
MetricQueryResponse
object
5 properties
NetworkInstPolicy
object
2 properties
appMapParams
object
Application map parameters
1 property
1 required
NetInstEdgeNodeCluster
object
2 properties
CustomConfigVariableGroup
object
4 properties
LispConfig
object
List Configurations.
6 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
EdgeviewCfg
object
7 properties
SANValues
object
6 properties
Interface
object
6 properties
ServicePoint
object
Service Point
3 properties
Deployments
object
3 properties
SKUDetail
object
3 properties
DockerRuntimeProtocolVersion
string
AllocationPolicy
string
Iot hub allocation policy.
Deployment
object
13 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
VariableGroupCondition
object
3 properties
ConfigurationLockPolicy
object
Configuration lock policy to enforce on all devices of the project
2 properties
1 required
EventSource
string
- EVENTSOURCEUNSPECIFIED: Default - EVENTSOURCESYSTEM: Event is generated as a result of status change reported by edge node / application - EVENTSOURCEUSER: E…
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
AzureResourceAndServices
object
Azure resource request payload for cloud policy
3 properties
3 required
Details
object
Edge Application Artifact Details
8 properties
1 required
DeploymentConfigSummary
object
12 properties
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
AzurePolicy
object
All azure policy related details that are required to provision an iot edge device and deploy a module on that.
8 properties
3 required
VolumeInstConfig
object
11 properties
ModuleDetail
object
Azure module specific details
4 properties
EnrollmentMechanism
string
attestation/mechanism supported by azure.
AppInstConfig
object
Edge application gets installed/uninstalled to/from edge node(s) and perform specific edge computing tasks. Lifecycle of Edge application (upgrade/restart) on…
20 properties
MetricsDetail
object
2 properties
AppConfig
object
Edge application configuration for an App policy defines configuration details of the Edge application to be installed to all Edge node(s) under the App policy.
20 properties
8 required
CustomConfig
object
7 properties
dhcpIpRange
object
DHCP IP range
2 properties
Author
object
5 properties
TagType
string
- TAGTYPEUNSPECIFIED: Unspecified - TAGTYPEGENERIC: Generic resource group - TAGTYPEPROJECT: Project resource group - TAGTYPEAZURE: Project resource group - TA…
AppPolicy
object
list of apps that will be provisioned on all the devices of the project to which this policy is attached
1 property
1 required
ImageDatastore
object
2 properties
NetworkInstanceKind
string
PolicyType
string
type of policy.
AppCategory
string
- APPCATEGORYUNSPECIFIED: Invalid Edge Application Category - APPCATEGORYOPERATINGSYSTEM: Edge operating systems - APPCATEGORYINDUSTRIAL: Connectity solution f…
AppType
string
type of app bundle.
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
IotHubServiceDetail
object
1 property
Subject
object
8 properties
AttestPolicyType
string
- ATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - ATTESTPOLICYTYPEENFORCE: Enforce attestation. Devices…
AppNamingSchemeV2
string
type of name aliasing.
AttestationPolicy
object
Attestation policy to enforce on all devices of the project
2 properties
1 required
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
StaticIPRoute
object
Static IP Routes
4 properties
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
VMManifest
object
26 properties
NetInstOpaqueConfig
object
Network Instance Opaque config. This is service specific configuration.
3 properties
LocalOperatorConsolePolicy
object
Local operator console policy to enforce on all devices of the project
3 properties
1 required
MapParams
object
1 property
InterfaceOrdering
string
- INTERFACEORDERINGDISABLED: Default value. interface order will not be sent to eve - INTERFACEORDERINGENABLED: interface ordering is enabled. interface order…
DevicePCRPolicy
object
PCR policy to define which TPM PCR registers to use for volume key sealing
2 properties
1 required
hvMode
string
For now we need to tell the device which virtualization mode to use. Later we might use a single one for all VMs (on any particular ISA). If we end up keeping…
PCRPolicy
object
PCR policy for TPM key sealing on devices
3 properties
1 required
VolumeInstanceAccessMode
string
PolicyCommon
object
6 properties
NetworkInstanceFlowLogTransmission
string
NetworkInstanceFlowLogTransmission represents the status of flow log transmission within a network instance. This enum is used to enable or disable the transmi…
IntegrationPolicy
object
4 properties
TagUpdate_HttpRequest
object
Resource group for edge gateway Base OS or for eedge applications.
20 properties
4 required
ContainerDetail
object
common container detail.
1 property
Tag
object
Resource group for edge gateway Base OS or for eedge applications.
21 properties
3 required
EdgeViewPolicy
object
Policy for device edgeview operation
7 properties
1 required
EnrollmentDetail
object
8 properties
IndividualCertificateEnrollment
object
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
VariableOptionVal
object
2 properties
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
googlerpcStatus
object
3 properties
DevicePortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on devices of a project
4 properties
PolicyStatus
string
policy status.
phyAdapter
object
Physical Adapter
3 properties
DevAccessPolicy
object
1 property
VMManifestImage
object
15 properties
ResourceGroupDetail
object
Resource group request payload for cloud policy
3 properties
2 required
AclAction
object
8 properties
EventQueryResponse
object
Event query response request payload
3 properties
2 required
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
TagLevelSettings
object
TagLevelSettings defines settings at a specific tag level within a enterprise. It includes configurations that control certain behaviors or features, such as t…
3 properties
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
Certificate
object
21 properties
AppNamingScheme
string
type of name aliasing.
CertificateEnrollmentDetail
object
3 properties
ModuleType
string
module type.
DPSServiceDetail
object
2 properties
NtpServer
object
NTP Server
1 property
UserDataTemplate
object
1 property
ClusterInstPolicy
object
4 properties
DockerRuntimeVersion
string
Summary
object
Summary is used to store the Summary details
3 properties
spType
string
clone of types defined in API repo. - SPTYPEMAPSERVER: mapping service for zededa overlay service - SPTYPESUPPORTSERVER: if device has support feature enabled,…
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties
1 required
EIDRegister
object
EID Register
10 properties
10 required
TPMEnrollmentDetail
object
1 property
IndividualSymmetricKeyEnrollment
object
1 property
appACE
object
App ACE Configuration
4 properties
4 required
AzureResourceAndServiceDetail
object
6 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties
5 required
JWTInfo
object
6 properties
Match
object
2 properties
appACEMatch
object
App ACE Match
2 properties
2 required
Resource
object
2 properties
GroupSymmetricKeyEnrollment
object
1 property
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
ExtAccessPolicy
object
1 property
ClusterPolicy
object
cluster policy to bring up cluster on devices in this project
4 properties
3 required
DeviceAttestationPolicy
object
Attestation policy to enforce on devices of a project
1 property
1 required
Param
object
2 properties
EdgeviewPolicy
object
Policy for device edgeview operation
6 properties
1 required
DeviceAttestPolicyType
string
- DEVICEATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - DEVICEATTESTPOLICYTYPEENFORCE: Enforce attestati…
vm
object
Virtual machine memory configuration
10 properties
4 required
NetInstConfig
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
26 properties
5 required
StaticDNSList
object
Static DNS list
2 properties
EventQueryResponseItem
object
Event query response item payload
14 properties
appACEAction
object
App ACE actions
7 properties
7 required
NetworkInstConfig
object
12 properties
DevicePolicy
object
5 properties
appInterface
object
App Interface detail
16 properties
1 required
MetricThreshold
object
2 properties
NetworkInstanceDhcpType
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zededa publishes across the network.