Zededa EdgeNetworkInstanceConfiguration API

openapi: 3.2.0
info:
  title: ZEDEDA App Profiles Service AppProfileService Edge Network Instance Configuration 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
servers:
- url: /api
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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetInstList'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          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'
        '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'
      parameters:
      - name: deviceName
        in: query
        required: false
        schema:
          type: string
      - name: projectName
        in: query
        required: false
        schema:
          type: string
      - name: namePattern
        in: query
        required: false
        schema:
          type: string
      - name: tags
        in: query
        required: false
        schema:
          type: string
      - name: deviceNamePattern
        in: query
        required: false
        schema:
          type: string
      - name: projectNamePattern
        in: query
        required: false
        schema:
          type: string
      - name: summary
        in: query
        required: false
        schema:
          type: boolean
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        schema:
          type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        schema:
          type: number
          format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        schema:
          type: number
          format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        schema:
          type: number
          format: int64
      - name: fields
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
          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'
        '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.
          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'
      parameters:
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetInstConfig'
        required: true
  /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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.
          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'
        '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'
      parameters:
      - name: id
        description: System defined universally unique Id of the network instance
        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
      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.
          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'
        '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'
      parameters:
      - name: id
        description: System defined universally unique Id of the network instance
        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
      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.
          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'
      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
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetInstConfigUpdate_HttpRequest'
        required: true
  /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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.
          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'
        '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'
      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
        schema:
          type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - EdgeNetworkInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
components:
  schemas:
    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-]+'
    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: '#/components/schemas/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: '#/components/schemas/NetworkInstanceKind'
          description: Kind of Network Instance ( Local, Switch etc )
        dhcp:
          type: boolean
          description: Deprecated
          title: dhcp - DEPRECATED
        type:
          $ref: '#/components/schemas/NetworkInstanceDhcpType'
          description: Type of DHCP for this Network Instance
        ip:
          $ref: '#/components/schemas/DhcpServerConfig'
          description: Dhcp Server Configuration
        dnsList:
          type: array
          items:
            $ref: '#/components/schemas/StaticDNSList'
          description: List of Static DNS entries
        oconfig:
          type: string
          title: Deprecated
        lisp:
          $ref: '#/components/schemas/LispConfig'
          description: 'Lisp Config : read only for now. Deprecated.'
        opaque:
          $ref: '#/components/schemas/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: '#/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:
          $ref: '#/components/schemas/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
    NetInstShortConfig:
      type: object
      example:
        id: d85a545f-6510-4327-b03d-c02eef119e99
        name: sample-app
      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
        deviceId:
          type: string
        projectId:
          type: string
        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: ^[^<%&?/\>]+$
        kind:
          $ref: '#/components/schemas/NetworkInstanceKind'
        type:
          $ref: '#/components/schemas/NetworkInstanceDhcpType'
        forwardLldp:
          type: boolean
        deviceDefault:
          type: boolean
        networkPolicyId:
          type: string
          description: network policy id
      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 summary configuration of a Network instance.
      title: Network instance summary configuration
    OpaqueConfigType:
      type: string
      enum:
      - OPAQUE_CONFIG_TYPE_UNSPECIFIED
      - OPAQUE_CONFIG_TYPE_VPN
      - OPAQUE_CONFIG_TYPE_LISP
      default: OPAQUE_CONFIG_TYPE_UNSPECIFIED
    ZsrvError:
      type: object
      properties:
        ec:
          $ref: '#/components/schemas/ZsrvErrorCode'
          title: 'Enumrated error code, describes more granular numerical

            value than just httpStatus'
        location:
          type: string
          title: 'Ignore: Internal field only'
        details:
          type: string
          title: Field captures string description of details
    NetInstList:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/NetInstShortConfig'
        cfgList:
          type: array
          items:
            $ref: '#/components/schemas/NetInstConfig'
        summaryByKind:
          $ref: '#/components/schemas/Summary'
          description: Summary information about netinstance list records by network instance kind.
        summaryByAddressType:
          $ref: '#/components/schemas/Summary'
          description: Summary information about netinstance list records by addressing type.
        next:
          $ref: '#/components/schemas/Cursor'
    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
          $ref: '#/components/schemas/ProbeConfig'
          description: Probe Configuration
      description: Static IP Routes
      title: Static IP Routes
    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
    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
          $ref: '#/components/schemas/commonConnectivityProbe'
          description: Custom probe configuration
      description: Probing configuration
      title: Probing configuration
    ServicePoint:
      type: object
      properties:
        type:
          type: object
          $ref: '#/components/schemas/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
    NtpServer:
      type: object
      properties:
        server:
          type: string
          description: NTP Server IP or FQDN
      description: NTP Server
      title: NTP Server
    protobufAny:
      type: object
      properties:
        typeUrl:
          type: string
        value:
          type: string
          format: byte
    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.
    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

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