> ## 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. # Update edge network instance > PUT /api/v1/netinsts/id/{id}. Edge networks 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: > >
    >
  1. Profile menu
  2. Help & Documentation
  3. API Reference
    4. >
> > 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-network.json) > [!WARNING] > > This operation can change resources or access. After signing in, open **API request settings** and select **Enable modifying requests**, then **Apply settings**, to use its playground. Check the request body and destination before selecting **Send**. Your existing API permissions still apply. 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. Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge network record. 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-network.json PUT /v1/netinsts/id/{id} openapi: 3.0.0 info: title: ZEDEDA Edge Network Service description: >- The ZEDEDA Edge Network Service is helper service to ZEDEDA Edge Application Service. This service provides edge nodes and applications a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communicate with Cloud Controller and Data Centres on one hand and logical secure connectivity between applications within a single edge node and within a logical group of edge nodes. This also supports secure tunnel from an edge node or an edge application in a remote location to a Data server behindi firewall in AWS or Azure or On-premise VPC. 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: EdgeNetworkConfiguration - name: EdgeNetworkInstanceConfiguration - name: EdgeNetworkInstanceStatus externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network paths: /v1/netinsts/id/{id}: put: tags: - EdgeNetworkInstanceConfiguration summary: Update edge network instance description: >- Update an edge network instance. The usual pattern to update an edge network instance record is to retrieve the record and update with the modified values in a new body to update the edge network instance record. operationId: EdgeNetworkInstanceConfiguration_UpdateEdgeNetworkInstance parameters: - name: id 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/NetInstConfigUpdate_HttpRequest' required: true responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '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' '409': description: >- Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge network record. 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' externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network components: schemas: NetInstConfigUpdate_HttpRequest: type: object properties: id: type: string description: System defined universally unique Id of the network instance pattern: '[0-9A-Za-z-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/NetInstConfigUpdate_HttpRequest/properties/id' keyword: uniqueItems sourceValue: true name: type: string description: >- User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/NetInstConfigUpdate_HttpRequest/properties/name' keyword: uniqueItems sourceValue: true title: type: string description: >- User defined title of the network instance. Title can be changed at any time maxLength: 256 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$ description: type: string description: Detailed description of the network instance maxLength: 256 revision: description: system defined info for the object allOf: - $ref: '#/components/schemas/ObjectRevision' projectId: type: string description: id of the project in which network instance is created tags: type: object additionalProperties: type: string description: >- 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. maxLength: 32 pattern: ^[^<%&?/\>]+$ clusterID: type: string description: id of the Cluster in which the network instance is configured maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: >- #/definitions/NetInstConfigUpdate_HttpRequest/properties/clusterID keyword: uniqueItems sourceValue: true deviceId: type: string description: id of the device on which network instance is created title: device on which this network is running port: type: string description: name of port mapping in the model title: name of port mapping in the model portTags: type: object additionalProperties: type: string description: >- 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. maxLength: 32 pattern: ^[^<%&?/\>]+$ kind: description: Kind of Network Instance ( Local, Switch etc ) allOf: - $ref: '#/components/schemas/NetworkInstanceKind' dhcp: type: boolean description: Deprecated title: dhcp - DEPRECATED type: description: Type of DHCP for this Network Instance allOf: - $ref: '#/components/schemas/NetworkInstanceDhcpType' ip: description: Dhcp Server Configuration allOf: - $ref: '#/components/schemas/DhcpServerConfig' dnsList: type: array items: $ref: '#/components/schemas/StaticDNSList' description: List of Static DNS entries oconfig: type: string title: Deprecated lisp: description: 'Lisp Config : read only for now. Deprecated.' allOf: - $ref: '#/components/schemas/LispConfig' opaque: description: Service specific Config allOf: - $ref: '#/components/schemas/NetInstOpaqueConfig' deviceDefault: type: boolean description: >- flag to indicate if this is the default network instance for the device title: flag to indicate if this is default network networkPolicyId: type: string description: id of the network policy to be attached to this network instance propagateConnectedRoutes: type: boolean description: Automatically propagate connected routes staticRoutes: type: array items: $ref: '#/components/schemas/StaticIPRoute' description: List of Static IP routes mtu: type: integer format: int64 description: >- Maximum transmission unit (MTU) to set for the network instance and all application interfaces connected to it edgeNodeCluster: description: Edge Node Cluster allOf: - $ref: '#/components/schemas/NetInstEdgeNodeCluster' forwardLldp: type: boolean description: enable/disable lldp frame forward description: >- Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge applications within a single Edge node and within a logical group of Edge nodes. This provides detailed configuration of a Network instance. title: Network instance detailed configuration required: - id - name - title - deviceId - port - kind 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' 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 NetworkInstanceKind: type: string enum: - NETWORK_INSTANCE_KIND_UNSPECIFIED - NETWORK_INSTANCE_KIND_TRANSPARENT - NETWORK_INSTANCE_KIND_SWITCH - NETWORK_INSTANCE_KIND_LOCAL - NETWORK_INSTANCE_KIND_CLOUD - NETWORK_INSTANCE_KIND_MESH - NETWORK_INSTANCE_KIND_HONEYPOT default: NETWORK_INSTANCE_KIND_UNSPECIFIED NetworkInstanceDhcpType: type: string enum: - NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED - NETWORK_INSTANCE_DHCP_TYPE_V4 - NETWORK_INSTANCE_DHCP_TYPE_V6 - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOEID - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV4 - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV6 default: NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED title: |- NetworkInstanceDhcpType: Used in the network instance provide dhcp server configuration DhcpServerConfig: type: object properties: subnet: type: string description: Subnet address mask: type: string description: Subnet Mask gateway: type: string description: IP Address of Network Gateway domain: type: string description: Network domain ntp: type: string description: IP Address of NTP Server title: ntp will be deprecated dns: type: array items: type: string description: IP Addresses of DNS servers title: possible DNS ip address dhcpRange: description: Range of IP addresses to be used for DHCP allOf: - $ref: '#/components/schemas/dhcpIpRange' ntpServers: type: array items: $ref: '#/components/schemas/NtpServer' description: NTP Servers StaticDNSList: type: object properties: hostname: type: string description: Host name addrs: type: array items: type: string description: Addresses description: Static DNS list title: Static DNS list LispConfig: type: object properties: lispiid: type: number format: int64 description: lisp id allocate: type: boolean description: Allocate flag exportprivate: type: boolean description: Export Private flag allocationprefix: type: string format: byte description: Allocation Prefix allocationprefixlen: type: number format: int64 description: Allocation Prefix Length sp: type: array items: $ref: '#/components/schemas/ServicePoint' description: Service Point List description: List Configurations. title: Lisp Configurations NetInstOpaqueConfig: type: object properties: type: type: string description: type of Opaque config allOf: - $ref: '#/components/schemas/OpaqueConfigType' oconfig: type: string description: base64 encoded string of opaque config lisp: description: >- Deprecated - Lisp config **Source definition conflict:** this property declares type `"string"`, while the referenced definition declares `"object"`. The referenced schema is shown; the conflicting declaration needs correction in ZEDEDA's Swagger definition. title: lisp - Deprecated allOf: - $ref: '#/components/schemas/LispConfig' x-zededa-source-issues: - code: conflicting-reference pointer: '#/definitions/NetInstOpaqueConfig/properties/lisp' keyword: type sourceValue: string reference: '#/definitions/LispConfig' referencedValue: object description: Network Instance Opaque config. This is service specific configuration. StaticIPRoute: type: object properties: prefix: type: string description: IP Prefix gateway: type: string description: Gateway IP outputPort: type: string description: Output Port probeConfig: type: object description: Probe Configuration allOf: - $ref: '#/components/schemas/ProbeConfig' description: Static IP Routes title: Static IP Routes NetInstEdgeNodeCluster: type: object properties: id: type: string description: Id of the Edge Node Cluster pattern: '[0-9A-Za-z-]+' designatedNodeID: type: string description: Id of the designated Edge Node pattern: '[0-9A-Za-z-]+' 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 dhcpIpRange: type: object properties: start: type: string description: starting IP end: type: string description: ending IP description: DHCP IP range title: DHCP IP range NtpServer: type: object properties: server: type: string description: NTP Server IP or FQDN description: NTP Server title: NTP Server ServicePoint: type: object properties: type: description: >- Service Point Type **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. allOf: - $ref: '#/components/schemas/spType' x-zededa-source-issues: - code: conflicting-reference pointer: '#/definitions/ServicePoint/properties/type' keyword: type sourceValue: object reference: '#/definitions/spType' referencedValue: string NameOrIp: type: string description: Service name/ service name Credential: type: string description: Service credentials description: Service Point title: Service Point OpaqueConfigType: type: string enum: - OPAQUE_CONFIG_TYPE_UNSPECIFIED - OPAQUE_CONFIG_TYPE_VPN - OPAQUE_CONFIG_TYPE_LISP default: OPAQUE_CONFIG_TYPE_UNSPECIFIED ProbeConfig: type: object properties: enableGatewayPing: type: boolean description: Enable gateway ping pingMaxCost: type: number format: int64 description: Ping max cost preferLowerCost: type: boolean description: Prefer lower cost preferStrongerWwanSignal: type: boolean description: Prefer stronger WWAN signal customProbeConfig: type: object description: Custom probe configuration allOf: - $ref: '#/components/schemas/commonConnectivityProbe' description: Probing configuration title: Probing configuration 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 spType: type: string enum: - SPTYPE_INVALIDSRV - SPTYPE_MAPSERVER - SPTYPE_SUPPORTSERVER default: SPTYPE_INVALIDSRV description: |- clone of types defined in API repo. - SPTYPE_MAPSERVER: mapping service for zededa overlay service - SPTYPE_SUPPORTSERVER: if device has support feature enabled, this ia cloud service which device can be reached. commonConnectivityProbe: type: object properties: probeMethod: description: Method to use to determine the connectivity status. allOf: - $ref: '#/components/schemas/commonConnectivityProbeMethod' probeEndpoint: description: |- Endpoint to probe using the selected probing mechanism to determine the connectivity status. allOf: - $ref: '#/components/schemas/commonProbeEndpoint' description: Configuration for user-defined connectivity-testing probe. commonConnectivityProbeMethod: type: string enum: - CONNECTIVITY_PROBE_METHOD_UNSPECIFIED - CONNECTIVITY_PROBE_METHOD_ICMP - CONNECTIVITY_PROBE_METHOD_TCP default: CONNECTIVITY_PROBE_METHOD_UNSPECIFIED description: |- User-defined method to use to determine the connectivity status. - CONNECTIVITY_PROBE_METHOD_UNSPECIFIED: Connectivity probing method is not specified and therefore will not be used. - CONNECTIVITY_PROBE_METHOD_ICMP: Use ICMP ping against the probed endpoint to determine the connectivity status. - CONNECTIVITY_PROBE_METHOD_TCP: Try to establish TCP connection with the probed endpoint to determine the connectivity status. commonProbeEndpoint: type: object properties: host: type: string description: IP address or FQDN. port: type: integer format: int64 description: |- TCP port required for CONNECTIVITY_PROBE_METHOD_TCP. Leave empty for CONNECTIVITY_PROBE_METHOD_ICMP. description: >- Address of a remote endpoint to probe in order to determine connectivity status. securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````