Nfon Customer IP Whitelist API

The Customer IP Whitelist API from Nfon — 2 operation(s) for customer ip whitelist.

Operations 4

GET /tenants/{participantExternalIdentifier}/ip-whitelist #
POST /tenants/{participantExternalIdentifier}/ip-whitelist #
DELETE /tenants/{participantExternalIdentifier}/ip-whitelist/{ipWhitelistId} #
GET /tenants/{participantExternalIdentifier}/ip-whitelist/{ipWhitelistId} #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nfon-customer-ip-whitelist-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nfon-customer-ip-whitelist-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: APIs for managing PBX configuration, tenants, operators, licenses, and related resources
  title: PBX Configuration Customer IP Whitelist API
  version: 2026.07.20
servers:
- url: /configuration/v1
tags:
- name: Customer IP Whitelist
paths:
  /tenants/{participantExternalIdentifier}/ip-whitelist:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer IP Whitelist
      operationId: get_110
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                type: object
              example:
                links: {}
                data:
                - value: 192.168.1.100
                  name: ipAddress
                - value: PERMANENT
                  name: type
                - value: PROVISIONING
                  name: usage
                - value: '2026-12-31'
                  name: validUntil
                - value: Office network
                  name: description
                href: /api/customers/example-id/ip-whitelist
          description: Success
        '403':
          description: Insufficient permissions
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/IpWhitelistPOSTRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer IP Whitelist
      operationId: post_34
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '403':
          description: Insufficient permissions
        '400':
          description: Validation error
        '201':
          description: Created
  /tenants/{participantExternalIdentifier}/ip-whitelist/{ipWhitelistId}:
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: ipWhitelistId
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer IP Whitelist
      operationId: delete_33
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Deleted
        '403':
          description: Insufficient permissions
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: ipWhitelistId
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer IP Whitelist
      operationId: get_111
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiResponse'
              example:
                links: {}
                data:
                - value: 192.168.1.100
                  name: ipAddress
                - value: PERMANENT
                  name: type
                - value: PROVISIONING
                  name: usage
                - value: '2026-12-31'
                  name: validUntil
                - value: Office network
                  name: description
                href: /api/customers/example-id/ip-whitelist/example-id
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
components:
  schemas:
    IpWhitelistPOSTRequest:
      properties:
        links:
          $ref: '#/components/schemas/NoLinks'
        data:
          $ref: '#/components/schemas/IpWhitelistPOSTData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    Links:
      description: Related resource links
      type: object
    NoLinks:
      type: object
    NfonApiResponse:
      properties:
        links:
          $ref: '#/components/schemas/Links'
        data:
          description: Resource data (name/value pairs or structured object)
          type: object
        href:
          example: /api/sip-servers/100
          type: string
          description: Self-link to this resource
      type: object
      description: Standard API response envelope for a single resource
    String:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          type: string
      type: object
      description: Link to the last page
    IpWhitelistPOSTData:
      properties:
        ipAddress:
          example: 192.168.1.100
          type: string
        type:
          $ref: '#/components/schemas/String'
        validUntil:
          $ref: '#/components/schemas/String'
        usage:
          $ref: '#/components/schemas/String'
        description:
          $ref: '#/components/schemas/String'
      type: object
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http