Zededa EdgeNetworkConfiguration API

The EdgeNetworkConfiguration API from Zededa — 4 operation(s) for edgenetworkconfiguration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zededa EdgeNetworkConfiguration API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EdgeNetworkConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 44 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://zedcontrol.zededa.net/api.

7 operations 4 paths 44 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 2.0

API Version

1.0

Base URL

https://zedcontrol.zededa.net/api

Authentication

API Key

Contact

ZEDEDA API Support

License

Apache 2.0

View terms

Resource Areas

Authentication & Security 1

Zededa EdgeNetworkConfiguration 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

EdgeNetworkConfiguration 7

GET

/v1/networks

Query edge networks

EdgeNetworkConfiguration_QueryEdgeNetworks 13 params → 200400401403500504default

POST

/v1/networks

Create edge network

EdgeNetworkConfiguration_CreateEdgeNetwork 2 params → 200400401403409500504default

GET

/v1/networks/id/{id}

Get edge network

EdgeNetworkConfiguration_GetEdgeNetwork 2 params → 200401403404500504default

DELETE

/v1/networks/id/{id}

Delete edge network

EdgeNetworkConfiguration_DeleteEdgeNetwork 2 params → 200401403404500504default

PUT

/v1/networks/id/{id}

Update edge network

EdgeNetworkConfiguration_UpdateEdgeNetwork 3 params → 200401403404409500504default

GET

/v1/networks/id/{id}/devices

Get edge network devices by id

EdgeNetworkConfiguration_GetEdgeNetworkDevicesById 2 params → 200401403404500504default

GET

/v1/networks/name/{name}

Get edge network

EdgeNetworkConfiguration_GetEdgeNetworkByName 2 params → 200401403404500504default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are NetCellularAccessPoint (16 properties), ZsrvResponse (15 properties), NetConfigForUpdate_HttpRequest (14 properties), NetConfig (14 properties). Each schema is shown below with its type and property counts.

NetworkWirelessType

string

NtpServer

object

NTP Server

1 property

ZcOpsType

string

ObjectType

string

NetworkDeviceList

object

1 property

NetCellularAccessPointSecrets

object

2 properties

Summary

object

Summary is used to store the Summary details

3 properties

commonCipherBlock

object

4 properties

commonCellularIPType

string

The IP addressing type to use for a given attach or default bearer. - CELLULARIPTYPEUNSPECIFIED: IP type is not specified. When unspecified, EVE will not enfor…

NetConfigList

object

6 properties

NetworkDHCPType

string

NetworkProxyProto

string

dhcpIpRange

object

DHCP IP range

2 properties

NetWifiConfigNetcryptoblock

object

2 properties

NetCellularAccessPoint

object

16 properties

NetProjectInfo

object

2 properties

protobufAny

object

2 properties

Cursor

object

Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.

5 properties

StaticDNSList

object

Static DNS list

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

NetCellularConfig

object

5 properties

NetProxyServer

object

Net Proxy Server

3 properties

NetWifiConfig

object

8 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:…

NetworkRelatedDevice

object

3 properties

NetWifiConfigSecrets

object

1 property

ZsrvError

object

3 properties

googlerpcStatus

object

3 properties

commonConnectivityProbeMethod

string

User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…

NetworkWiFiKeyScheme

string

CellularAuthProtocol

string

- CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP: Password Authentication Protocol. - CELLULARAUTHPROTOCOLCHAP: Challenge-Handshake Aut…

IpSpec

object

11 properties

evecommonRadioAccessTechnology

string

- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…

commonConnectivityProbe

object

Configuration for user-defined connectivity-testing probe.

2 properties

NetworkKind

string

evecommonCellularAuthProtocol

string

CellularAuthProtocol defines the authentication protocol used for cellular connection. - CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP…

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…

NetWirelessConfig

object

3 properties

NetConfig

object

Network provides Edge nodes a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communi…

14 properties 5 required

NetProxyConfig

object

Net Proxy Configurations

6 properties

commonProbeEndpoint

object

Address of a remote endpoint to probe in order to determine connectivity status.

2 properties

NetConfigForUpdate_HttpRequest

object

Network provides Edge nodes a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communi…

14 properties 7 required

configCellularConnectivityProbe

object

CellularConnectivityProbe is used to periodically check the connectivity status of a cellular network by probing a remote endpoint. Whenever the probe fails, t…

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Zededa publishes across the network.

Zededa AppProfileService API

AE Profile APIs.io

Zededa ArtifactManager API

AE Profile APIs.io

Zededa AssetGroupService API

AE Profile APIs.io

Zededa BulkJobOps API

AE Profile APIs.io

Zededa CertificateEnrollmentProfileConfiguration API

AE Profile APIs.io

Zededa CloudDiagnostics API

AE Profile APIs.io

Zededa ClusterGroups API

AE Profile APIs.io

Zededa ClusterStatus API

AE Profile APIs.io

Zededa DatastoreConfiguration API

AE Profile APIs.io

Zededa EdgeApplicationConfiguration API

AE Profile APIs.io

Zededa EdgeApplicationInstanceConfiguration API

AE Profile APIs.io

Zededa EdgeApplicationInstanceStatus API

AE Profile APIs.io

#EdgeNetworkConfiguration

← Back to Z APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zededa EdgeNetworkConfiguration API

Metadata

Authentication & Security 1

Paths & Operations 7

Schemas 44

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zededa EdgeNetworkConfiguration API

Metadata

Authentication & Security 1

Paths & Operations 7

Schemas 44

Specification

Source

More from Zededa 12

API Details

Provider

Explore more