Zededa ResourceGroup API
The ResourceGroup API from Zededa — 11 operation(s) for resourcegroup.
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 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
18 operations
11 paths
165 schemas
3 DELETE10 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa ResourceGroup API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (BearerToken).
By default, every request must be authenticated.
BearerToken— Bearer token for user session
Paths & Operations 18
Across 11 paths, the API surfaces 18 operations — 3 DELETE, 10 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
ResourceGroup 18
GET
/v1/projects
Query resource groups
POST
/v1/projects
Create resource group
GET
/v1/projects/id/{id}
Get resource group
DELETE
/v1/projects/id/{id}
Delete resource group
PUT
/v1/projects/id/{id}
Update resource group
GET
/v1/projects/id/{objid}/events
Get resource group events by id
GET
/v1/projects/id/{objid}/timeSeries/{mType}
Get resource group resource usage timeline
GET
/v1/projects/name/{name}
Get resource group
GET
/v1/projects/name/{objname}/events
Get resource group events by name
GET
/v1/projects/name/{objname}/timeSeries/{mType}
Get resource group resource usage timeline
GET
/v1/projects/tags
Query resource group tag key-values
POST
/v2/projects
Create resource group
GET
/v2/projects/id/{projectId}/deployments
Get deployment list in a project by ID
DELETE
/v2/projects/id/{projectId}/deployments
Delete all deployments in a project
POST
/v2/projects/id/{projectId}/deployments
Create deployment for a project
GET
/v2/projects/id/{projectId}/deployments/id/{id}
Get specific deployment status in a project by project ID and deployment ID
DELETE
/v2/projects/id/{projectId}/deployments/id/{id}
Delete deployment in a project
PUT
/v2/projects/id/{projectId}/deployments/id/{id}
Update deployment in a project
Schemas 165
The contract defines 165 schemas that model the data the API accepts and returns. The most detailed are NetInstConfig (26 properties), VMManifest (26 properties), Certificate (21 properties), Tag (21 properties). Each schema is shown below with its type and property counts.
appACEMatch
object
App ACE Match
2 properties
2 required
NetworkInstPolicy
object
2 properties
DevAccessPolicy
object
1 property
NtpServer
object
NTP Server
1 property
EAPMethod
string
DevicePolicy
object
5 properties
Summary
object
Summary is used to store the Summary details
3 properties
EventQueryResponseItem
object
Event query response item payload
14 properties
Subject
object
8 properties
Interface
object
6 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
InterfaceOrdering
string
- INTERFACEORDERINGDISABLED: Default value. interface order will not be sent to eve - INTERFACEORDERINGENABLED: interface ordering is enabled. interface order…
NetworkInstanceDhcpType
string
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
EdgeviewPolicy
object
Policy for device edgeview operation
6 properties
1 required
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
ServicePoint
object
Service Point
3 properties
DevicePolicyType
string
VolumeInstPolicy
object
2 properties
StaticDNSList
object
Static DNS list
2 properties
MetricQueryResponseItem
object
2 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties
5 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
VolumeInstanceAccessMode
string
SANValues
object
6 properties
DeploymentConfigSummary
object
12 properties
Tags
object
4 properties
Tag
object
Resource group for edge gateway Base OS or for eedge applications.
21 properties
3 required
AppInstPolicy
object
2 properties
DevicePCRPolicy
object
PCR policy to define which TPM PCR registers to use for volume key sealing
2 properties
1 required
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
AppType
string
type of app bundle.
EnrollmentType
string
enrollment types.
DeploymentType
string
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
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
AttestPolicyType
string
- ATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - ATTESTPOLICYTYPEENFORCE: Enforce attestation. Devices…
EventSource
string
- EVENTSOURCEUNSPECIFIED: Default - EVENTSOURCESYSTEM: Event is generated as a result of status change reported by edge node / application - EVENTSOURCEUSER: E…
ConfigurationLockPolicy
object
Configuration lock policy to enforce on all devices of the project
2 properties
1 required
GroupCertificateEnrollment
object
1 property
NetworkInstanceKind
string
ObjectTag
object
Object tag deaails.
3 properties
Author
object
5 properties
DockerRuntimeVersion
string
ResourceGroupDetail
object
Resource group request payload for cloud policy
3 properties
2 required
MetricsDetail
object
2 properties
ExtAccessPolicy
object
1 property
AllocationPolicy
string
Iot hub allocation policy.
Deployment
object
13 properties
EnrollmentDetail
object
8 properties
PolicyStatus
string
policy status.
LispConfig
object
List Configurations.
6 properties
NetworkInstConfig
object
12 properties
VariableGroupCondition
object
3 properties
PolicyCommon
object
6 properties
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
Certificate
object
21 properties
AttestationPolicy
object
Attestation policy to enforce on all devices of the project
2 properties
1 required
VolumeInstanceType
string
OpaqueConfigType
string
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
AzureResourceAndServices
object
Azure resource request payload for cloud policy
3 properties
3 required
PCRPolicy
object
PCR policy for TPM key sealing on devices
3 properties
1 required
AppInstanceLogs
object
App Instance Logs configuration
1 property
1 required
appInterface
object
App Interface detail
16 properties
1 required
MapParams
object
1 property
vm
object
Virtual machine memory configuration
10 properties
4 required
AppCategory
string
- APPCATEGORYUNSPECIFIED: Invalid Edge Application Category - APPCATEGORYOPERATINGSYSTEM: Edge operating systems - APPCATEGORYINDUSTRIAL: Connectity solution f…
TagUpdate_HttpRequest
object
Resource group for edge gateway Base OS or for eedge applications.
20 properties
4 required
ModuleType
string
module type.
DockerRuntimeProtocolVersion
string
Details
object
Edge Application Artifact Details
8 properties
1 required
PortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on all devices of the project
5 properties
DeviceAttestationPolicy
object
Attestation policy to enforce on devices of a project
1 property
1 required
DhcpServerConfig
object
8 properties
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties
1 required
RSA
object
1 property
appACE
object
App ACE Configuration
4 properties
4 required
Param
object
2 properties
ProbeConfig
object
Probing configuration
5 properties
MetricQueryResponse
object
5 properties
ObjectType
string
IndividualCertificateEnrollment
object
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
DPSServiceDetail
object
2 properties
MetricThreshold
object
2 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
VMManifest
object
26 properties
protobufAny
object
2 properties
GroupSymmetricKeyEnrollment
object
1 property
EventQueryResponse
object
Event query response request payload
3 properties
2 required
AppNamingSchemeV2
string
type of name aliasing.
ClusterPolicy
object
cluster policy to bring up cluster on devices in this project
4 properties
3 required
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
configFormat
string
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
NetInstOpaqueConfig
object
Network Instance Opaque config. This is service specific configuration.
3 properties
StaticIPRoute
object
Static IP Routes
4 properties
ZsrvError
object
3 properties
Match
object
2 properties
Permission
object
Acl
object
3 properties
LispServer
object
LispServer request payload
2 properties
2 required
SKUDetail
object
3 properties
ConfigurationLock
string
ImageDatastore
object
2 properties
DeviceAttestPolicyType
string
- DEVICEATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - DEVICEATTESTPOLICYTYPEENFORCE: Enforce attestati…
CustomConfig
object
7 properties
VMManifestImage
object
15 properties
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
ClusterConfig
object
1 property
AzureResourceAndServiceDetail
object
6 properties
EvAuthType
string
EdgeViewPolicy
object
Policy for device edgeview operation
7 properties
1 required
VmBootloaderMode
string
IntegrationPolicy
object
4 properties
phyAdapter
object
Physical Adapter
3 properties
ZcOpsType
string
EnrollmentMechanism
string
attestation/mechanism supported by azure.
AclAction
object
8 properties
JWTInfo
object
6 properties
dhcpIpRange
object
DHCP IP range
2 properties
ModuleDetail
object
Azure module specific details
4 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
EIDRegister
object
EID Register
10 properties
10 required
spType
string
clone of types defined in API repo. - SPTYPEMAPSERVER: mapping service for zededa overlay service - SPTYPESUPPORTSERVER: if device has support feature enabled,…
IotHubServiceDetail
object
1 property
AppNamingScheme
string
type of name aliasing.
NetworkInstanceFlowLogTransmission
string
NetworkInstanceFlowLogTransmission represents the status of flow log transmission within a network instance. This enum is used to enable or disable the transmi…
PolicyType
string
type of policy.
ClusterType
string
LimitParams
object
3 properties
SymmetricKeyEnrollmentDetail
object
3 properties
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
ClusterInstPolicy
object
4 properties
UserDataTemplate
object
1 property
VariableGroupConditionOperator
string
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
ECDSA
object
1 property
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…
NetInstEdgeNodeCluster
object
2 properties
ContainerDetail
object
common container detail.
1 property
LocalOperatorConsolePolicy
object
Local operator console policy to enforce on all devices of the project
3 properties
1 required
DevicePortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on devices of a project
4 properties
TPMEnrollmentDetail
object
1 property
googlerpcStatus
object
3 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
SendDeviceMetrics
string
SendDeviceMetrics controls whether device metrics are sent to the cloud for devices in a project. - SENDDEVICEMETRICSUNSPECIFIED: Default value. Setting is not…
appMapParams
object
Application map parameters
1 property
1 required
EdgeviewCfg
object
7 properties
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
appACEAction
object
App ACE actions
7 properties
7 required
CertificateEnrollmentDetail
object
3 properties
Deployments
object
3 properties
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
CustomConfigVariableGroup
object
4 properties
IndividualSymmetricKeyEnrollment
object
1 property
VolumeInstConfig
object
11 properties
Resource
object
2 properties
ZsrvResponse
object
15 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
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
AppAccessPolicy
object
1 property
VariableOptionVal
object
2 properties
TagType
string
- TAGTYPEUNSPECIFIED: Unspecified - TAGTYPEGENERIC: Generic resource group - TAGTYPEPROJECT: Project resource group - TAGTYPEAZURE: Project resource group - TA…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zededa 12
Other APIs Zededa publishes across the network.
Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
#ResourceGroup