Zededa EdgeNetworkInstanceConfiguration API

swagger: '2.0'
info:
  title: ZEDEDA App Profiles Service AppProfileService EdgeNetworkInstanceConfiguration API
  description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
  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
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EdgeNetworkInstanceConfiguration
paths:
  /v1/netinsts:
    get:
      summary: Query edge network instances
      description: Query the edge network instance records.
      operationId: EdgeNetworkInstanceConfiguration_QueryEdgeNetworkInstances
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstList'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: deviceName
        in: query
        required: false
        type: string
      - name: projectName
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: tags
        in: query
        required: false
        type: string
      - name: deviceNamePattern
        in: query
        required: false
        type: string
      - name: projectNamePattern
        in: query
        required: false
        type: string
      - name: summary
        in: query
        required: false
        type: boolean
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: fields
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    post:
      summary: Create edge network instance
      description: Create an edge network instance record.
      operationId: EdgeNetworkInstanceConfiguration_CreateEdgeNetworkInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this edge network record will conflict with an already existing edge network record.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetInstConfig'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/id/{id}:
    get:
      summary: Get edge network instance
      description: Get the configuration (without security details) of an edge network instance record.
      operationId: EdgeNetworkInstanceConfiguration_GetEdgeNetworkInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstConfig'
        '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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        description: System defined universally unique Id of the network instance
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    delete:
      summary: Delete edge network instance
      description: Delete an edge network instance record.
      operationId: EdgeNetworkInstanceConfiguration_DeleteEdgeNetworkInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        description: System defined universally unique Id of the network instance
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    put:
      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
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge network record.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetInstConfigUpdate_HttpRequest'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/name/{name}:
    get:
      summary: Get edge network instance
      description: Get the configuration (without security details) of an edge network instance record.
      operationId: EdgeNetworkInstanceConfiguration_GetEdgeNetworkInstanceByName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstConfig'
        '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.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/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.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: name
        description: User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
definitions:
  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
  NtpServer:
    type: object
    properties:
      server:
        type: string
        description: NTP Server IP or FQDN
    description: NTP Server
    title: NTP Server
  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
  NetInstList:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/NetInstShortConfig'
      cfgList:
        type: array
        items:
          $ref: '#/definitions/NetInstConfig'
      summaryByKind:
        $ref: '#/definitions/Summary'
        description: Summary information about netinstance list records by network instance kind.
      summaryByAddressType:
        $ref: '#/definitions/Summary'
        description: Summary information about netinstance list records by addressing type.
      next:
        $ref: '#/definitions/Cursor'
  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: '#/definitions/ServicePoint'
        description: Service Point List
    description: List Configurations.
    title: Lisp Configurations
  Summary:
    type: object
    properties:
      description:
        type: string
        description: Summary description
      total:
        type: number
        format: int64
        description: Total
      values:
        type: object
        additionalProperties:
          type: integer
          format: int64
        description: 'Values: Map for storing <string, uint32>'
    description: Summary is used to store the Summary details
    title: Summary is used to store the Summary details
  dhcpIpRange:
    type: object
    properties:
      start:
        type: string
        description: starting IP
      end:
        type: string
        description: ending IP
    description: DHCP IP range
    title: DHCP IP range
  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\n   dhcp server configuration"
  protobufAny:
    type: object
    properties:
      typeUrl:
        type: string
      value:
        type: string
        format: byte
  ServicePoint:
    type: object
    properties:
      type:
        type: object
        $ref: '#/definitions/spType'
        description: Service Point Type
      NameOrIp:
        type: string
        description: Service name/ service name
      Credential:
        type: string
        description: Service credentials
    description: Service Point
    title: Service Point
  Cursor:
    type: object
    properties:
      pageToken:
        type: string
        description: Page Token
      orderBy:
        type: array
        items:
          type: string
        description: OrderBy helps in sorting the list response
      pageNum:
        type: number
        format: int64
        description: Page Number
      pageSize:
        type: number
        format: int64
        description: Defines the page size
      totalPages:
        type: number
        format: int64
        description: Total number of pages to be fetched.
    description: 'Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. '
    title: Cursor is used as filter in list operation.
  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
  spType:
    type: string
    enum:
    - SPTYPE_INVALIDSRV
    - SPTYPE_MAPSERVER
    - SPTYPE_SUPPORTSERVER
    default: SPTYPE_INVALIDSRV
    description: "clone of types defined in API repo.\n\n - SPTYPE_MAPSERVER: mapping service for zededa overlay service\n - SPTYPE_SUPPORTSERVER: if device has support feature enabled, this ia cloud service\nwhich device can be reached."
  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
  OpaqueConfigType:
    type: string
    enum:
    - OPAQUE_CONFIG_TYPE_UNSPECIFIED
    - OPAQUE_CONFIG_TYPE_VPN
    - OPAQUE_CONFIG_TYPE_LISP
    default: OPAQUE_CONFIG_TYPE_UNSPECIFIED
  NetInstConfig:
    type: object
    properties:
      id:
        type: string
        description: System defined universally unique Id of the network instance
        readOnly: true
        pattern: '[0-9A-Za-z-]+'
        uniqueItems: 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_.-]+'
        uniqueItems: 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:
        $ref: '#/definitions/ObjectRevision'
        description: system defined info for the object
      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_.-]+'
        uniqueItems: 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:
        $ref: '#/definitions/NetworkInstanceKind'
        description: Kind of Network Instance ( Local, Switch etc )
      dhcp:
        type: boolean
        description: Deprecated
        title: dhcp - DEPRECATED
      type:
        $ref: '#/definitions/NetworkInstanceDhcpType'
        description: Type of DHCP for this Network Instance
      ip:
        $ref: '#/definitions/DhcpServerConfig'
        description: Dhcp Server Configuration
      dnsList:
        type: array
        items:
          $ref: '#/definitions/StaticDNSList'
        description: List of Static DNS entries
      oconfig:
        type: string
        title: Deprecated
      lisp:
        $ref: '#/definitions/LispConfig'
        description: 'Lisp Config : read only for now. Deprecated.'
      opaque:
        $ref: '#/definitions/NetInstOpaqueConfig'
        description: Service specific Config
      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: '#/definitions/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:
        $ref: '#/definitions/NetInstEdgeNodeCluster'
        description: Edge Node Cluster
      forwardLldp:
        type: boolean
        description: 'Enables forwarding of LLDP (Link Layer Discovery Protocol) frames across this

          network instance.

          LLDP is used by devices to advertise identity and capabilities to directly

          connected neighbors, and is often required for topology discovery and network

          management tools.

          When enabled, LLDP frames (EtherType 0x88cc) are not dropped or suppressed

          by the forwarding plane.'
    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:
    - name
    - title
    - deviceId
    - port
    - kind
  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\n - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.\n - 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
  NetInstConfigUpdate_HttpRequest:
    type: object
    properties:
      id:
        type: string
        description: System defined universally unique Id of the network instance
        pattern: '[0-9A-Za-z-]+'
        uniqueItems: 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_.-]+'
        uniqueItems: 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:
        $ref: '#/definitions/ObjectRevision'
        description: system defined info for the object
      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_.-]+'
        uniqueItems: 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:
        $ref: '#/definitions/NetworkInstanceKind'
        description: Kind of Network Instance ( Local, Switch etc )
      dhcp:
   

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgenetworkinstanceconfiguration-api-openapi.yml