KPN Cellular Gateway.configure API

openapi: 3.2.0
info:
  version: 1.54.0
  title: KPN SD-LAN SD-WAN Network View Cellular Gateway.configure API
  description: "The SD-LAN SD-WAN Network View API is a modern REST API based on the OpenAPI specification.\n    \nThe Network View API gives users read rights to retrieve information from the `Network View API` resources. \n    \n- **Note**: By default you have read only access but based on your requirements and contract you can be granted `Manager` access to this API which is more than read only. To request manager access, please contact us at api_developer@kpn.com.\n\n---\n## [Source view](https://app.swaggerhub.com/apis/kpn/kpn-sd_lan_sd_wan_network_view_api/)<br/> [Documentation view](https://app.swaggerhub.com/apis-docs/kpn/kpn-sd_lan_sd_wan_network_view_api/)\n---\n## [KPN Developer](https://developer.kpn.com/)<br/> [Getting Started](https://developer.kpn.com/getting-started)"
servers:
- url: https://api-prd.kpn.com/kpn/meraki
security:
- OAuth2ClientCredentials: []
tags:
- name: cellularGateway.configure
paths:
  /devices/{serial}/cellularGateway/lan:
    get:
      description: Show the LAN Settings of a MG
      operationId: getDeviceCellularGatewayLan
      parameters:
      - name: serial
        in: path
        description: Serial
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  deviceName:
                    type: string
                    description: Name of the MG.
                  deviceLanIp:
                    type: string
                    description: Lan IP of the MG
                  deviceSubnet:
                    type: string
                    description: Subnet configuration of the MG.
                  fixedIpAssignments:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: A descriptive name of the assignment
                        ip:
                          type: string
                          description: The IP address you want to assign to a specific server or device
                        mac:
                          type: string
                          description: The MAC address of the server or device that hosts the internal resource that you wish to receive the specified IP address
                    description: list of all fixed IP assignments for a single MG
                  reservedIpRanges:
                    type: array
                    items:
                      type: object
                      properties:
                        start:
                          type: string
                          description: Starting IP included in the reserved range of IPs
                        end:
                          type: string
                          description: Ending IP included in the reserved range of IPs
                        comment:
                          type: string
                          description: Comment explaining the reserved IP range
                    description: list of all reserved IP ranges for a single MG
              example:
                deviceName: name of the MG
                deviceLanIp: 192.168.0.33
                deviceSubnet: 192.168.0.32/27
                fixedIpAssignments:
                - name: server 1
                  ip: 192.168.0.10
                  mac: 0b:00:00:00:00:ac
                reservedIpRanges:
                - start: 192.168.1.0
                  end: 192.168.1.1
                  comment: A reserved IP range
      summary: Show the LAN Settings of a MG
      tags:
      - cellularGateway.configure
    put:
      description: Update the LAN Settings for a single MG.
      operationId: updateDeviceCellularGatewayLan
      parameters:
      - name: serial
        in: path
        description: Serial
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reservedIpRanges:
                  type: array
                  items:
                    type: object
                    properties:
                      start:
                        type: string
                        description: Starting IP included in the reserved range of IPs
                      end:
                        type: string
                        description: Ending IP included in the reserved range of IPs
                      comment:
                        type: string
                        description: Comment explaining the reserved IP range
                    required:
                    - start
                    - end
                    - comment
                  description: list of all reserved IP ranges for a single MG
                fixedIpAssignments:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: A descriptive name of the assignment
                      ip:
                        type: string
                        description: The IP address you want to assign to a specific server or device
                      mac:
                        type: string
                        description: The MAC address of the server or device that hosts the internal resource that you wish to receive the specified IP address
                    required:
                    - ip
                    - mac
                  description: list of all fixed IP assignments for a single MG
              example:
                reservedIpRanges:
                - start: 192.168.1.0
                  end: 192.168.1.1
                  comment: A reserved IP range
                fixedIpAssignments:
                - name: server 1
                  ip: 192.168.0.10
                  mac: 0b:00:00:00:00:ac
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  deviceName:
                    type: string
                    description: Name of the MG.
                  deviceLanIp:
                    type: string
                    description: Lan IP of the MG
                  deviceSubnet:
                    type: string
                    description: Subnet configuration of the MG.
                  fixedIpAssignments:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: A descriptive name of the assignment
                        ip:
                          type: string
                          description: The IP address you want to assign to a specific server or device
                        mac:
                          type: string
                          description: The MAC address of the server or device that hosts the internal resource that you wish to receive the specified IP address
                    description: list of all fixed IP assignments for a single MG
                  reservedIpRanges:
                    type: array
                    items:
                      type: object
                      properties:
                        start:
                          type: string
                          description: Starting IP included in the reserved range of IPs
                        end:
                          type: string
                          description: Ending IP included in the reserved range of IPs
                        comment:
                          type: string
                          description: Comment explaining the reserved IP range
                    description: list of all reserved IP ranges for a single MG
              example:
                deviceName: name of the MG
                deviceLanIp: 192.168.0.33
                deviceSubnet: 192.168.0.32/27
                fixedIpAssignments:
                - name: server 1
                  ip: 192.168.0.10
                  mac: 0b:00:00:00:00:ac
                reservedIpRanges:
                - start: 192.168.1.0
                  end: 192.168.1.1
                  comment: A reserved IP range
      summary: Update the LAN Settings for a single MG.
      tags:
      - cellularGateway.configure
  /devices/{serial}/cellularGateway/portForwardingRules:
    get:
      description: Returns the port forwarding rules for a single MG.
      operationId: getDeviceCellularGatewayPortForwardingRules
      parameters:
      - name: serial
        in: path
        description: Serial
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: A descriptive name for the rule
                        lanIp:
                          type: string
                          description: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
                        publicPort:
                          type: string
                          description: A port or port ranges that will be forwarded to the host on the LAN
                        localPort:
                          type: string
                          description: A port or port ranges that will receive the forwarded traffic from the WAN
                        allowedIps:
                          type: array
                          items:
                            type: string
                          description: An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges.
                        protocol:
                          type: string
                          description: TCP or UDP
                        access:
                          type: string
                          description: '`any` or `restricted`. Specify the right to make inbound connections on the specified ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
                    description: An array of port forwarding params
              example:
                rules:
                - name: test
                  lanIp: 172.31.128.5
                  publicPort: 11-12
                  localPort: '4'
                  allowedIps:
                  - 10.10.10.10
                  - 10.10.10.11
                  protocol: tcp
                  access: any
      summary: Returns the port forwarding rules for a single MG.
      tags:
      - cellularGateway.configure
    put:
      description: Updates the port forwarding rules for a single MG.
      operationId: updateDeviceCellularGatewayPortForwardingRules
      parameters:
      - name: serial
        in: path
        description: Serial
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: A descriptive name for the rule
                      lanIp:
                        type: string
                        description: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
                      publicPort:
                        type: string
                        description: A port or port ranges that will be forwarded to the host on the LAN
                      localPort:
                        type: string
                        description: A port or port ranges that will receive the forwarded traffic from the WAN
                      allowedIps:
                        type: array
                        items:
                          type: string
                        description: An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges.
                      protocol:
                        type: string
                        description: TCP or UDP
                      access:
                        type: string
                        description: '`any` or `restricted`. Specify the right to make inbound connections on the specified ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
                    required:
                    - lanIp
                    - publicPort
                    - localPort
                    - protocol
                    - access
                  description: An array of port forwarding params
              example:
                rules:
                - name: test
                  lanIp: 172.31.128.5
                  publicPort: 11-12
                  localPort: '4'
                  allowedIps:
                  - 10.10.10.10
                  - 10.10.10.11
                  protocol: tcp
                  access: any
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: A descriptive name for the rule
                        lanIp:
                          type: string
                          description: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
                        publicPort:
                          type: string
                          description: A port or port ranges that will be forwarded to the host on the LAN
                        localPort:
                          type: string
                          description: A port or port ranges that will receive the forwarded traffic from the WAN
                        allowedIps:
                          type: array
                          items:
                            type: string
                          description: An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges.
                        protocol:
                          type: string
                          description: TCP or UDP
                        access:
                          type: string
                          description: '`any` or `restricted`. Specify the right to make inbound connections on the specified ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
                    description: An array of port forwarding params
              example:
                rules:
                - name: test
                  lanIp: 172.31.128.5
                  publicPort: 11-12
                  localPort: '4'
                  allowedIps:
                  - 10.10.10.10
                  - 10.10.10.11
                  protocol: tcp
                  access: any
      summary: Updates the port forwarding rules for a single MG.
      tags:
      - cellularGateway.configure
  /networks/{networkId}/cellularGateway/connectivityMonitoringDestinations:
    get:
      description: Return the connectivity testing destinations for an MG network
      operationId: getNetworkCellularGatewayConnectivityMonitoringDestinations
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  destinations:
                    type: array
                    items:
                      type: object
                      properties:
                        ip:
                          type: string
                          description: The IP address to test connectivity with
                        description:
                          type: string
                          description: Description of the testing destination. Optional, defaults to an empty string
                        default:
                          type: boolean
                          description: Boolean indicating whether this is the default testing destination (true) or not (false). Defaults to false. Only one default is allowed
                    description: The list of connectivity monitoring destinations
              example:
                destinations:
                - ip: 1.2.3.4
                  description: Google
                  default: false
      summary: Return the connectivity testing destinations for an MG network
      tags:
      - cellularGateway.configure
    put:
      description: Update the connectivity testing destinations for an MG network
      operationId: updateNetworkCellularGatewayConnectivityMonitoringDestinations
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                destinations:
                  type: array
                  items:
                    type: object
                    properties:
                      ip:
                        type: string
                        description: The IP address to test connectivity with
                      description:
                        type: string
                        description: Description of the testing destination. Optional, defaults to an empty string
                        default: ''
                      default:
                        type: boolean
                        description: Boolean indicating whether this is the default testing destination (true) or not (false). Defaults to false. Only one default is allowed
                        default: false
                    required:
                    - ip
                  description: The list of connectivity monitoring destinations
              example:
                destinations:
                - ip: 1.2.3.4
                  description: Google
                  default: false
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  destinations:
                    type: array
                    items:
                      type: object
                      properties:
                        ip:
                          type: string
                          description: The IP address to test connectivity with
                        description:
                          type: string
                          description: Description of the testing destination. Optional, defaults to an empty string
                        default:
                          type: boolean
                          description: Boolean indicating whether this is the default testing destination (true) or not (false). Defaults to false. Only one default is allowed
                    description: The list of connectivity monitoring destinations
              example:
                destinations:
                - ip: 1.2.3.4
                  description: Google
                  default: false
      summary: Update the connectivity testing destinations for an MG network
      tags:
      - cellularGateway.configure
  /networks/{networkId}/cellularGateway/dhcp:
    get:
      description: List common DHCP settings of MGs
      operationId: getNetworkCellularGatewayDhcp
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  dhcpLeaseTime:
                    type: string
                    enum:
                    - 1 day
                    - 1 hour
                    - 1 week
                    - 12 hours
                    - 30 minutes
                    - 4 hours
                    description: DHCP Lease time for all MG in the network.
                  dnsNameservers:
                    type: string
                    enum:
                    - custom
                    - google_dns
                    - opendns
                    - upstream_dns
                    description: DNS name servers mode for all MG in the network.
                  dnsCustomNameservers:
                    type: array
                    items:
                      type: string
                    description: List of fixed IPs representing the the DNS Name servers when the mode is 'custom'.
              example:
                dhcpLeaseTime: 1 hour
                dnsNameservers: custom
                dnsCustomNameservers:
                - 172.16.2.111
                - 172.16.2.30
      summary: List common DHCP settings of MGs
      tags:
      - cellularGateway.configure
    put:
      description: Update common DHCP settings of MGs
      operationId: updateNetworkCellularGatewayDhcp
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dhcpLeaseTime:
                  type: string
                  description: DHCP Lease time for all MG of the network. Possible values are '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'.
                dnsNameservers:
                  type: string
                  description: 'DNS name servers mode for all MG of the network. Possible values are: ''upstream_dns'', ''google_dns'', ''opendns'', ''custom''.'
                dnsCustomNameservers:
                  type: array
                  items:
                    type: string
                  description: list of fixed IPs representing the the DNS Name servers when the mode is 'custom'
              example:
                dhcpLeaseTime: 1 hour
                dnsNameservers: custom
                dnsCustomNameservers:
                - 172.16.2.111
                - 172.16.2.30
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  dhcpLeaseTime:
                    type: string
                    enum:
                    - 1 day
                    - 1 hour
                    - 1 week
                    - 12 hours
                    - 30 minutes
                    - 4 hours
                    description: DHCP Lease time for all MG in the network.
                  dnsNameservers:
                    type: string
                    enum:
                    - custom
                    - google_dns
                    - opendns
                    - upstream_dns
                    description: DNS name servers mode for all MG in the network.
                  dnsCustomNameservers:
                    type: array
                    items:
                      type: string
                    description: List of fixed IPs representing the the DNS Name servers when the mode is 'custom'.
              example:
                dhcpLeaseTime: 1 hour
                dnsNameservers: custom
                dnsCustomNameservers:
                - 172.16.2.111
                - 172.16.2.30
      summary: Update common DHCP settings of MGs
      tags:
      - cellularGateway.configure
  /networks/{networkId}/cellularGateway/subnetPool:
    get:
      description: Return the subnet pool and mask configured for MGs in the network.
      operationId: getNetworkCellularGatewaySubnetPool
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  deploymentMode:
                    type: string
                    description: Deployment mode for the cellular gateways in the network. (Passthrough/Routed)
                  cidr:
                    type: string
                    description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from this pool.
                  mask:
                    type: integer
                    description: Mask used for the subnet of all MGs in  this network.
                  subnets:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: Serial Number of the MG.
                        name:
                          type: string
                          description: Name of the MG.
                        applianceIp:
                          type: string
                          description: Appliance IP of the MG device.
                        subnet:
                          type: string
                          description: Subnet of MG device.
                    description: List of subnets of all MGs in this network.
              example:
                deploymentMode: routed
                cidr: 192.168.0.0/16
                mask: 24
                subnets:
                - serial: AAAA-AAAA-AAAA
                  name: my first MG
                  applianceIp: 192.168.0.1
                  subnet: 192.168.0.0/24
      summary: Return the subnet pool and mask configured for MGs in the network.
      tags:
      - cellularGateway.configure
    put:
      description: Update the subnet pool and mask configuration for MGs in the network.
      operationId: updateNetworkCellularGatewaySubnetPool
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                mask:
                  type: integer
                  description: Mask used for the subnet of all MGs in  this network.
                cidr:
                  type: string
                  description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from this pool.
              example:
                mask: 24
                cidr: 192.168.0.0/16
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  deploymentMode:
                    type: string
                    description: Deployment mode for the cellular gateways in the network. (Passthrough/Routed)
                  cidr:
                    type: string
                    description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from this pool.
                  mask:
                    type: integer
                    description: Mask used for the subnet of all MGs in  this network.
                  subnets:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: Serial Number of the MG.
                        name:
                          type: string
                          description: Name of the MG.
                        applianceIp:
                          type: string
                          description: Appliance IP of the MG device.
                        subnet:
                          type: string
                          description: Subnet of MG device.
                    description: List of subnets of all MGs in this network.
              example:
                deploymentMode: routed
                cidr: 192.168.0.0/16
                mask: 24
                subnets:
                - serial: AAAA-AAAA-AAAA
                  name: my first MG
                  applianceIp: 192.168.0.1
                  subnet: 192.168.0.0/24
      summary: Update the subnet pool and mask configuration for MGs in the network.
      tags:
      - cellularGateway.configure
  /networks/{networkId}/cellularGateway/uplink:
    get:
      description: Returns the uplink settings for your MG network.
      operationId: getNetworkCellularGatewayUplink
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  bandwidthLimits:
                    type: object
                    properties:
                      limitUp:
                        type: integer
                        description: The maximum upload limit (integer, in Kbps). 'null' indicates no limit.
                      limitDown:
                        type: integer
                        description: The maximum download limit (integer, in Kbps). 'null' indicates no limit.
                    description: The bandwidth settings for the 'cellular' uplink
              example:
                bandwidthLimits:
                  limitUp: 51200
                  limitDown: 51200
      summary: Returns the uplink settings for your MG network.
      tags:
      - cellularGateway.configure
    put:
      description: Updates the uplink settings for your MG network.
      operationId: updateNetworkCellularGatewayUplink
      parameters:
      - name: networkId
        in: path
        description: Network ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bandwidthLimits:
                  type: object
                  properties:
                    limitUp:
                      type: integer
                      description: The maximum upload limit (integer, in Kbps). null indicates no limit
                    limitDown:
                      type: integer
                      description: The maximum download limit (integer, in Kbps). null indicates no lim

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kpn/refs/heads/main/openapi/kpn-cellulargateway-configure-api-openapi.yml